Class Config

Hierarchy

Config

Implements

I18nConfig

Index

Constructors

constructor

Properties

Methods

Object literals

forkLinkedFields

Constructors

constructor

new Config(config?: I18nConfig, isFork?: boolean): Config

- Defined in src/config.ts:35
Parameters
- Default value config: I18nConfig = {}
- Default value isFork: boolean = false
Returns Config

Properties

cookieName

cookieName: string = null

defaultLocale

defaultLocale: string = "en"

fallbacks

fallbacks: I18nFallbacks

Private forks

forks: Config[] = []

Private Readonly isConstructed

isConstructed: boolean = false

isDestroyed

isDestroyed: boolean = false

Private isFork

isFork: boolean = false

locales

locales: I18nLocales

objectNotation

objectNotation: boolean = false

processors

processors: I18nProcessor[] = []

queryParameter

queryParameter: string = "locale"

unknownPhraseListener

unknownPhraseListener: I18nUnknownPhraseListener = null

Methods

addLocale

addLocale(locale: string, catalog: I18nLangLocales): this

- Defined in src/config.ts:394
Add new translations.

Parameters
- locale: string
  
  Locale to add.
- catalog: I18nLangLocales
  
  Catalog for localte to add.
Returns this

Config.

bind

bind<T>(fn: T): T
bind<A, B, C, D>(fns: []): []

- Defined in src/config.ts:219
Create translate function copy, binded to another config.

Type parameters
- T: Function
Parameters
- fn: T
  
  Translate function.
Returns T

Binded function.
- Defined in src/config.ts:226
Create translate functions copy, binded to another config.

Type parameters
- A: Function
- B: Function
- C: Function
- D: Function
Parameters
- fns: []
  
  Translate functions.
Returns []

Binded functions.

Private callForkMethod

callForkMethod(caller: (fork: Config) => void, flagName: keyof I18nForkLinkedFields): void

- Defined in src/config.ts:195
Call given method for all forks.

Parameters
- caller: (fork: Config) => void
  
  Function to call method of fork.
  - - (fork: Config): void
    - Parameters
      - fork: Config
      Returns void
- flagName: keyof I18nForkLinkedFields
  
  Flag name to check ability to call method.
Returns void

configure

configure(__namedParameters: { cookieName: string; defaultLocale: string; fallbacks: {}; locales: I18nLocales; objectNotation: boolean; processors: ((text: string, namedValues: any, values: any[], count?: number) => string)[]; queryParameter: string; unknownPhraseListener: (locale: string, phrase: string, value: I18nLocale) => void }): this

- Defined in src/config.ts:55
Change config.

Parameters
- __namedParameters: { cookieName: string; defaultLocale: string; fallbacks: {}; locales: I18nLocales; objectNotation: boolean; processors: ((text: string, namedValues: any, values: any[], count?: number) => string)[]; queryParameter: string; unknownPhraseListener: (locale: string, phrase: string, value: I18nLocale) => void }
  - cookieName: string
  - defaultLocale: string
  - fallbacks: {}
  - locales: I18nLocales
  - objectNotation: boolean
  - processors: ((text: string, namedValues: any, values: any[], count?: number) => string)[]
  - queryParameter: string
  - unknownPhraseListener: (locale: string, phrase: string, value: I18nLocale) => void
    - - (locale: string, phrase: string, value: I18nLocale): void
      - Parameters
        
        locale: string
        
        phrase: string
        
        value: I18nLocale
        
        Returns void
Returns this

Config.

destroy

destroy(): void

- Defined in src/config.ts:143
Destroy instance.

Returns void

fork

fork(config?: I18nForkConfig, hard?: boolean): Config
fork(config: I18nConfig, hard: true): Config

- Defined in src/config.ts:163
Copy current config with some overrides.

Parameters
- Optional config: I18nForkConfig
  
  Config with overrides.
- Optional hard: boolean
  
  Do hard fork without linked fields.
Returns Config

Forked config.
- Defined in src/config.ts:171
Copy current config with some overrides.

Parameters
- config: I18nConfig
  
  Config with overrides.
- hard: true
  
  Do hard fork without linked fields.
Returns Config

Forked config.

getCatalog

getCatalog(locale?: string): I18nLangLocales

- Defined in src/config.ts:369
Get whole catalog optionally based on given locale.

Parameters
- Optional locale: string
  
  Locale to get sub-catalog.
Returns I18nLangLocales

Catalog.

getLocale

getLocale(checkFallback?: true, localeToCheck?: string, strict?: boolean): string

- Defined in src/config.ts:321
Get current locale.

Parameters
- Optional checkFallback: true
  
  Flag to use fallback or not.
- Optional localeToCheck: string
  
  Locale to handle.
- Default value strict: boolean = false
  
  Should fall back to default locale or not.
Returns string

Current locale.

getLocales

getLocales(): string[]

- Defined in src/config.ts:354
Get available locales.

Returns string[]

Available locales.

onUnknownPhrase

onUnknownPhrase(listener: I18nUnknownPhraseListener): this

- Defined in src/config.ts:259
Set function to call when unknown phrase was translated.

Parameters
- listener: I18nUnknownPhraseListener
  
  Locale change listener.
Returns this

Config.

removeLocale

removeLocale(locale: string): this

- Defined in src/config.ts:415
Remove translations.

Parameters
- locale: string
  
  Locale to remove.
Returns this

Config.

setLocale

setLocale(locale: string): this

- Defined in src/config.ts:282
Set current locale.

Parameters
- locale: string
  
  Locale to set.
Returns this

Config.

Object literals

Private forkLinkedFields

forkLinkedFields: object

defaultLocale

defaultLocale: true = true

locales

locales: true = true

unknownPhraseListener

unknownPhraseListener: true = true

Generated using TypeDoc