Interface LocaleSource

Internal representation of the available locale configuration.

Generally not something you will want to use directly.

interface LocaleSource {
    currentLocale: Locale;
    locales: Locale[];
    t: TFunction;
    loadNamespaces(namespaces: string[]): Promise<void>;
}

Index

Methods

Properties

currentLocale locales t

Methods

loadNamespaces

loadNamespaces(namespaces: string[]): Promise<void>
Loads the given namespaces, if not already done.
Parameters
- namespaces: string[]
  Array of namespace names to load
Returns Promise<void>
Promise which resolves once loaded.
- Defined in packages/sanity/src/core/i18n/types.ts:225

Properties

currentLocale

currentLocale: Locale

Current locale ID (eg en-US, nb-NO, th-TH…)

locales

locales: Locale[]

Array of locale definitions

t

t: TFunction

Translation function, eg t('some.key') => 'Some string'