API / Settings / Settings

Defined in: src/settings/types.ts:70

Library settings. The object is implemented as a singleton that manages global configuration for all DateTime instances throughout the application

Example

import {settings} from '@gravity-ui/date-utils';

// Get current locale
const currentLocale = settings.getLocale(); // default is "en"

Methods

getDefaultTimeZone()

getDefaultTimeZone(): string

Defined in: src/settings/types.ts:83

Returns

string


getLocale()

getLocale(): string

Defined in: src/settings/types.ts:73

Returns

string


getLocaleData()

getLocaleData(): Locale

Defined in: src/settings/types.ts:75

Returns

Locale


loadLocale()

loadLocale(locale): Promise<void>

Defined in: src/settings/types.ts:71

Parameters

Parameter Type
locale string

Returns

Promise<void>


setDefaultTimeZone()

setDefaultTimeZone(zone): void

Defined in: src/settings/types.ts:81

Parameters

Parameter Type
zone "system" | string & object

Returns

void


setLocale()

setLocale(locale): void

Defined in: src/settings/types.ts:77

Parameters

Parameter Type
locale string

Returns

void


setRelativeParser()

setRelativeParser(parser): void

Defined in: src/settings/types.ts:85

Parameters

Parameter Type
parser Parser

Returns

void


updateLocale()

updateLocale(config): void

Defined in: src/settings/types.ts:79

Parameters

Parameter Type
config UpdateLocaleConfig

Returns

void

Previous