Date Time Api

Represents a date-time value formatter. This API is part of the data-management modules within the Relativity web components library, which is made directly available via the convenienceApi. These functions are available under the `convenienceApi.dateTime` namespace.

Methods

getFormatter(options) ⇒ Object

Returns a formatter object that can be used to format date-time strings to a given locale

Properties Details

getFormatter(options) ⇒ Object

Returns a formatter object that can be used to format date-time strings to a given locale

Returns: Object - A formatter object used to format date-time strings for a given locale

Param	Type	Description
options	Object	Provides DateTime formatting options and configuration.
options.errorText	String	Provides parsed error text.
options.includeSeconds	Boolean	Indicates whether the formatter includes seconds in the output string.
options.includeTime	Boolean	Indicates whether the formatter includes time in the output string.
options.isUTC	Boolean	Indicates whether the date-time string given to the formatter is a UTC time. When true, the output will be converted to the local timezone of the user's browser.
options.locale	String	Indicates the BCP 47 language tag, such as "en-US", or "de-DE", to which the output string will be localized.