Locales | dayspan

A class for holding all supported locales. You can add your own, add aliases, or set the current locale.

Hierarchy

Locales

Index

Properties

ref

Accessors

current

Methods

Object literals

map

Properties

Static ref

ref: Ref<Locale> = new Ref<Locale>(en, true)

The reference to the current locale.

Accessors

Static current

current:

The current locale.

Methods

Static add

add(key: string | string[], locale: Locale): void

- Defined in Locale.ts:161
Adds a new locale under one or many keys.

Parameters
- key: string | string[]
  
  The locale key or keys.
- locale: Locale
  
  The locale definition.
Returns void

Static alias

alias(key: string, aliases: string[]): void

- Defined in Locale.ts:177
Aliases an existing locale with other keys.

Parameters
- key: string
  
  The existing locale to alias.
- aliases: string[]
  
  The other keys to use an aliases.
Returns void

Static get

get(key: string): Locale

- Defined in Locale.ts:227
Returns the locale with the given code. If the code does not map to a locale the current locale is returned.

Parameters
- key: string
  
  The code to get the locale for.
Returns Locale

Static normal

normal(x: string): string

- Defined in Locale.ts:216
Normalizes a locale code to a map key.

Parameters
- x: string
  
  The code to normalize to a key.
Returns string

Static set

set(key: string): boolean

- Defined in Locale.ts:198
Sets the current locale to the locale with the given key. If no locale exists with the given key, false is returned.

When the global locale changes all Day instances created with an unspecified locale will lazily update their locale-based values when they are accessed following a locale change.

Parameters
- key: string
  
  The key of a locale.
Returns boolean

True if the locale was found, otherwise false.

Object literals

Static map

map: object

The map of locales available.

en

Generated using TypeDoc