SpecificTranslateConfig

type SpecificTranslateConfig = object;

Defined in: src/types/config.type.ts:45

Specific translation configuration

Since

1.0.0

Author

Simon Kovtyk

Properties

defaultScope?

readonly optional defaultScope: string;

Defined in: src/types/config.type.ts:69

Overrides the global scope, which should be used as default scope when no scope is provided. Default is null.

Since

1.0.0

Author

Simon Kovtyk

---

fallbackToSourceLocale?

readonly optional fallbackToSourceLocale: boolean;

Defined in: src/types/config.type.ts:77

Fallback to source locale translations, when a translation is missing in the current locale. Default is false.

Since

1.0.0

Author

Simon Kovtyk

---

locales

readonly locales: LocaleConfig[];

Defined in: src/types/config.type.ts:53

The locales in Form of LocaleConfig, your app should support

Since

1.0.0

Author

Simon Kovtyk

---

storageConfig?

readonly optional storageConfig: object;

Defined in: src/types/config.type.ts:85

Configuration for storing locale and translations in the browser storage

collectingStrategy?

readonly optional collectingStrategy: CollectingStrategy;

The CollectingStrategy to use for collecting translations to store in the browser storage

Since

1.0.0

Author

Simon Kovtyk

locale?

readonly optional locale: object;

Configuration for storing the current locale in the browser storage

Since

1.0.0

Author

Simon Kovtyk

locale.key?

readonly optional key: string;

The key to use for storing the current locale

Since

1.0.0

Author

Simon Kovtyk

locale.store?

readonly optional store: boolean;

Wether to store the current locale in the browser storage or not. Default is false.

Since

1.0.0

Author

Simon Kovtyk

locale.type?

readonly optional type: Storage;

The storage type to use for storing the current locale (e.g. localeStorage or sessionStorage)

Since

1.0.0

Author

Simon Kovtyk

translations?

readonly optional translations: object;

Configuration for storing the translations in the browser storage

Since

1.0.0

Author

Simon Kovtyk

translations.key?

readonly optional key: string;

The key to use for storing the translations

Since

1.0.0

Author

Simon Kovtyk

translations.store?

readonly optional store: boolean;

Wether to store the translations in the browser storage or not. Default is false.

Since

1.0.0

Author

Simon Kovtyk

translations.type?

readonly optional type: Storage;

The storage type to use for storing the translations (e.g. localeStorage or sessionStorage)

Since

1.0.0

Author

Simon Kovtyk

Since

1.0.0

Author

Simon Kovtyk

---

timeout?

readonly optional timeout: number;

Defined in: src/types/config.type.ts:61

The timeout for HTTP requests in millisecond

Since

1.0.0

Author

Simon Kovtyk