Class IntlOptionsProvider

An OptionsProvider implementation that handles Standard Date and Time Format Specifiers. The type of the returned options object is an extended version of Intl.DateTimeFormat's options parameter.

Hierarchy

IntlOptionsProvider

Implements

OptionsProvider<DateTimeFormatOptions>

Index

Constructors

constructor

Properties

Methods

Object literals

resolvers_

Constructors

constructor

new IntlOptionsProvider(dateTimeOptions: DateTimeFormatOptions): IntlOptionsProvider

- Defined in core/Globalization/DateTime/IntlOptionsProvider.ts:23
Creates an instance with base formatting options which will be extended and/or overridden by resolved options.

Parameters
- dateTimeOptions: DateTimeFormatOptions
  
  A base options object containing properties defined for the Intl.DateTimeFormat's options parameter.
Returns IntlOptionsProvider

Properties

Private options_

options_: DateTimeFormatOptions

Private style_

style_: string

Methods

getStyle

getStyle(): string

Implementation of OptionsProvider.getStyle
- Defined in core/Globalization/DateTime/IntlOptionsProvider.ts:54
Returns the formatting style to use. Values should match the property names defined in Specifiers.StandardSpecifiersMap.

Returns string

resolveOptions

resolveOptions(format: string, value: Date): DateTimeFormatOptions

Implementation of OptionsProvider.resolveOptions
- Defined in core/Globalization/DateTime/IntlOptionsProvider.ts:43
Returns an object that provides date and time formatting options resolved from standard date and time specifiers.

Parameters
- format: string
  
  A format string representing a Standard Date and Time Format Specifiers.
- value: Date
  
  The date object from which to infer additional options.
Returns DateTimeFormatOptions

Private tryInitializeSpecifierOptions_

tryInitializeSpecifierOptions_(format: string): boolean

- Defined in core/Globalization/DateTime/IntlOptionsProvider.ts:63
Parameters
- format: string
Returns boolean

useUTC

useUTC(): boolean

Implementation of OptionsProvider.useUTC
- Defined in core/Globalization/DateTime/IntlOptionsProvider.ts:59
Returns whether to use UTC time or not.

Returns boolean

Object literals

Private resolvers_

resolvers_: object

rfc1123

rfc1123: function

See: https://msdn.microsoft.com/library/az4se3k1.aspx#RFC1123

Type declaration

- (): T
- Returns T

roundTrip

roundTrip: function

See: https://msdn.microsoft.com/library/az4se3k1.aspx#Roundtrip

Type declaration

- (): T
- Returns T

sortable

sortable: function

See: https://msdn.microsoft.com/library/az4se3k1.aspx#Sortable

Type declaration

- (): T
- Returns T

fullDateLongTime

fullDateLongTime(): void

- Defined in core/Globalization/DateTime/IntlOptionsProvider.ts:105
See: https://msdn.microsoft.com/library/az4se3k1.aspx#FullDateLongTime

Returns void

fullDateShortTime

fullDateShortTime(): void

- Defined in core/Globalization/DateTime/IntlOptionsProvider.ts:99
See: https://msdn.microsoft.com/library/az4se3k1.aspx#FullDateShortTime

Returns void

generalDateLongTime

generalDateLongTime(): void

- Defined in core/Globalization/DateTime/IntlOptionsProvider.ts:117
See: https://msdn.microsoft.com/library/az4se3k1.aspx#GeneralDateLongTime

Returns void

generalDateShortTime

generalDateShortTime(): void

- Defined in core/Globalization/DateTime/IntlOptionsProvider.ts:111
See: https://msdn.microsoft.com/library/az4se3k1.aspx#GeneralDateShortTime

Returns void

longDate

longDate(): void

- Defined in core/Globalization/DateTime/IntlOptionsProvider.ts:92
See: https://msdn.microsoft.com/library/az4se3k1.aspx#LongDate

Returns void

longTime

longTime(): void

- Defined in core/Globalization/DateTime/IntlOptionsProvider.ts:144
See: https://msdn.microsoft.com/library/az4se3k1.aspx#LongTime

Returns void

monthDate

monthDate(): void

- Defined in core/Globalization/DateTime/IntlOptionsProvider.ts:123
See: https://msdn.microsoft.com/library/az4se3k1.aspx#MonthDay

Returns void

shortDate

shortDate(): void

- Defined in core/Globalization/DateTime/IntlOptionsProvider.ts:85
See: https://msdn.microsoft.com/library/az4se3k1.aspx#ShortDate

Returns void

shortTime

shortTime(): void

- Defined in core/Globalization/DateTime/IntlOptionsProvider.ts:138
See: https://msdn.microsoft.com/library/az4se3k1.aspx#ShortTime

Returns void

universalFull

universalFull(): void

- Defined in core/Globalization/DateTime/IntlOptionsProvider.ts:155
See: https://msdn.microsoft.com/library/az4se3k1.aspx#UniversalFull

Returns void

universalSortable

universalSortable(): void

- Defined in core/Globalization/DateTime/IntlOptionsProvider.ts:150
See: https://msdn.microsoft.com/library/az4se3k1.aspx#UniversalSortable

Returns void

yearMonth

yearMonth(): void

- Defined in core/Globalization/DateTime/IntlOptionsProvider.ts:161
See: https://msdn.microsoft.com/library/az4se3k1.aspx#YearMonth

Returns void

Generated using TypeDoc