Class Localization

This is the main class of the Localization module. This class contains all the static methods that will be used for leveraging localization within your project

Hierarchy

Localization

Index

Constructors

constructor

Methods

Constructors

constructor

new Localization(): Localization

Returns Localization

Methods

Static addPipeFunction

addPipeFunction(idenbt: string, fn: LocalizationPipeFunction): void

- Defined in Localization.ts:193
Adds a LocalizationPipeFunction with the given identifier to the cache

Parameters
- idenbt: string
- fn: LocalizationPipeFunction
Returns void

Static getKeys

getKeys(path: ResourcePath): string[]

- Defined in Localization.ts:176
Returns an array of resource keys for the given resource path. The array will be empty if none exist.

Parameters
- path: ResourcePath
Returns string[]

Static getPipeFunction

getPipeFunction(ident: string): undefined | LocalizationPipeFunction

- Defined in Localization.ts:202
Gets the LocalizationPipeFunction with the given identifier from the cache and returns it

Parameters
- ident: string
Returns undefined | LocalizationPipeFunction

Static getResourceProxy

getResourceProxy<T>(path: ResourcePath): LocalizationResourceProxy<T>

- Defined in Localization.ts:150
Gets a LocalizationResourceProxy for the given path. Uses a cached resource proxy if one already exists for the given path

Type parameters
- T: {} = {}
Parameters
- path: ResourcePath
Returns LocalizationResourceProxy<T>

Static hasPipeFunction

hasPipeFunction(ident: string): boolean

- Defined in Localization.ts:185
Returns whether or not the cache has a LocalizationPipeFunction with the given identifier

Parameters
- ident: string
Returns boolean

Static loadFromDirectory

loadFromDirectory(language: string, dir: string): void

- Defined in Localization.ts:25
Loads and parses all .lang files in the given directory (and subdirectories therein) and caches them under the given language

Parameters
- language: string
- dir: string
Returns void

Static loadLangFile

loadLangFile(language: string, file: string): void

- Defined in Localization.ts:33
Loads and parses the given .lang file, caching it under the given language

Parameters
- language: string
- file: string
Returns void

Static resource

resource(path: ResourcePath, key: string, args?: TemplateArguments): string

- Defined in Localization.ts:51
Fetches a Localization string resource for the given path and key. The string will be built using the given arguments

Parameters
- path: ResourcePath
- key: string
- Optional args: TemplateArguments
Returns string

Static resourceExists

resourceExists(path: ResourcePath, key: string): boolean

- Defined in Localization.ts:141
Returns whether or not a Localization resource exists for the given path.

NOTE: Does not check the fallback language

Parameters
- path: ResourcePath
- key: string
Returns boolean

Static setFallbackLanguage

setFallbackLanguage(language: string): void

- Defined in Localization.ts:42
Sets the fallback language to use if a resource doesn't exist for the language given to Localization.resource()

Parameters
- language: string
Returns void

Generated using TypeDoc