IntlService

An abstract base class that implements the Internationalization service methods for the current locale.

Methods

dateFieldName

Returns a localized date field name based on specific dateFieldName options.

Copy CodedateFieldName({ type: 'day' });                      //returns 'day';
dateFieldName({ type: 'day', nameType: 'wide' });    //returns 'day';
dateFieldName({ type: 'month', nameType: 'short' }); //returns 'mo.';
dateFieldName({ type: 'month', nameType: 'wide' });  //returns 'month';

Parameters

options

Detailed configuration for the desired date field name.

localeId?

The optional locale id. If not specified, the "en" locale id is used.

Returns

The localized date field name from the current locale based on the option.

dateFormatNames

Returns the day names from the current locale based on the option.

Parameters

options

Detailed configuration for the desired date format.

localeId?

The locale ID to use in place of the default. Optional.

Returns

• The day names from the current locale based on the option.

firstDay

Returns the first day index starting from Sunday.

Parameters

localeId?

The locale ID. Defaults to the current locale ID.

Returns

• The index of the first day of the week (0 == Sunday).

format

Formats a string with placeholders such as Total amount {0:c}.

Parameters

format

The format string.

values

One or more values to output in the format string placeholders.

Returns

• The formatted string.

formatDate

Converts a Date object into a string based on the specified format (see example). If no format is provided, the default short date format is used.

Parameters

value

The date to format.

format?

The format string or options.

localeId?

The locale ID to use in place of the default. Optional.

Returns

• The formatted date.

formatNumber

Converts a Number into a string based on the specified format.

Parameters

value

The number to format.

format

The format string or options.

localeId?

The locale ID to use in place of the default. Optional.

Returns

• The formatted number.

notify

Notifies that the service was changed.

numberSymbols

Returns the number symbols from the current locale based on the option.

Parameters

localeId?

The locale ID to use in place of the default one. Optional.

Returns

• The number symbols from the current locale.

parseDate

Converts a string into a Date object based on the specified format.

Parameters

value

The string to convert.

format?

The format strings or options.

localeId?

The locale ID to use in place of the default. Optional.

Returns

• The parsed date.

parseNumber

Converts a string into a Number.

Parameters

value

The string to convert.

format?

The format string or options.

localeId?

The locale ID to use in place of the default. Optional.

Returns

• The parsed number.

splitDateFormat

Splits the date format into objects containing information about each part of the pattern.

Parameters

format

The format string or options.

localeId?

The optional locale id. If not specified, the "en" locale id is used.

Returns

The date format parts.

toString

Converts an object into a string based on the specified format.

Parameters

value

The value to format.

format

The format to use.

localeId?

The locale ID to use in place of the default. Optional.

Returns

• The formatted object.

weekendRange

Returns the start and end index of the locale weekend starting from Sunday.

Parameters

localeId?

The locale ID. Defaults to the current locale ID.

Returns

• The the start and end index of the locale weekend (0 == Sunday).