docs(dateFieldName): add API documentation for the method

Author: ggkrustev

docs/cldr/api.md

@@ -86,6 +86,55 @@ The names.
 
 If the type is `"dayPeriods"` or `"eras"`, an object is returned. For the other types, the result is `Array`.
 
+### dateFieldName
+
+Returns a localized date field name based on a specific format specifier.
+
+#### dateFieldName Parameters
+
+##### options `Object`
+
+The options that determine the returned date field name.
+
+##### options.type `String`
+
+The type of the date field name.
+
+The supported values are:
+* `"era"`
+* `"year"`
+* `"quarter"`
+* `"month"`
+* `"week"`
+* `"day"`
+* `"weekday"`
+* `"dayperiod"`
+* `"hour"`
+* `"minute"`
+* `"second"`
+* `"zone"`
+
+##### options.nameType `String`
+
+The format name type.
+
+The supported values are:
+* `"wide"`
+* `"narrow"`
+* `"short"`
+
+##### locale `String`
+
+The locale id.
+
+#### dateFieldName Return Value
+
+##### Returns `String`
+
+The date field name.
+
+If an information for the specified date field type is missing, a `undefined` is returned.
+
 ### numberSymbols
 
 Returns the number symbols from the specified locale.

docs/cldr/index.md

@@ -26,6 +26,7 @@ The following table provides the data formats that are required for number and d
 | Basic dates                  | `cldr/main/locale/ca-gregorian.json`   |
 | Localized timezone           | `cldr/main/locale/timeZoneNames.json`  |
 | Numeric week day formatting  | `cldr/supplemental/weekData.json`      |
+| Localized date field names   | `cldr/supplemental/dateFields.json`    |
 
 ## Getting CLDR Data
 
@@ -43,6 +44,7 @@ const numbers = require("cldr-data/main/bg/numbers.json");
 const timeZoneNames = require("cldr-data/main/bg/timeZoneNames.json");
 const calendar = require("cldr-data/main/bg/ca-gregorian.json");
 const currencies = require("cldr-data/main/bg/currencies.json");
+const currencies = require("cldr-data/main/bg/dateFields.json");
 const weekData = require("cldr-data/supplemental/weekData.json");
 const currencyData = require("cldr-data/supplemental/currencyData.json");
 
@@ -53,6 +55,7 @@ load(
     numbers,
     currencies,
     calendar,
+    dateFields,
     timeZoneNames
 );
 

src/cldr.d.ts

@@ -62,7 +62,7 @@ export interface DateFieldNameOptions {
 /**
  * Returns a localized date field name based on a specific format specifier.
  *
- * @param formatSpecifier The dateFieldName options.
+ * @param options The dateFieldName options.
  * @param locale The optional locale id. If not specified, the `"en"` locale id is used.
  * @returns The localized date field name determined by the dateFieldName options.
  *
@@ -74,7 +74,7 @@ export interface DateFieldNameOptions {
  * dateFieldName({ type: 'month', nameType: 'wide' });  //returns 'month';
  * ```
  */
-export function dateFieldName(formatSpecifier: DateFieldNameOptions, locale?: string): string;
+export function dateFieldName(options: DateFieldNameOptions, locale?: string): string;
 
 /**
  * Returns the first day index starting from Sunday based on the specified locale.