@univerjs/sheets-data-validation v0.1.17 • Docs

Class: LocaleService

This service provides i18n and timezone / location features to other modules.

Extends

• Disposable

Constructors

new LocaleService()

new LocaleService(): LocaleService

Returns

LocaleService

Overrides

Disposable.constructor

Defined in

packages/core/src/services/locale/locale.service.ts:36 (opens in a new tab)

Properties

Methods

dispose()

dispose(): void

Returns

void

Inherited from

Disposable.dispose

Defined in

packages/core/src/shared/lifecycle.ts:106 (opens in a new tab)

disposeWithMe()

protected disposeWithMe(disposable): IDisposable

Parameters

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)

getCurrentLocale()

getCurrentLocale(): LocaleType

Returns

LocaleType

Defined in

packages/core/src/services/locale/locale.service.ts:101 (opens in a new tab)

getLocales()

getLocales(): undefined | ILanguagePack

Returns

undefined | ILanguagePack

Defined in

packages/core/src/services/locale/locale.service.ts:97 (opens in a new tab)

load()

load(locales): void

Load more locales after init.

Parameters

Returns

void

Defined in

packages/core/src/services/locale/locale.service.ts:47 (opens in a new tab)

resolveKeyPath()

resolveKeyPath(obj, keys): null | LanguageValue

Parameters

Returns

null | LanguageValue

Defined in

packages/core/src/services/locale/locale.service.ts:105 (opens in a new tab)

setLocale()

setLocale(locale): void

Parameters

Returns

void

Defined in

packages/core/src/services/locale/locale.service.ts:92 (opens in a new tab)

t()

t(key, ...args): string

Translate a key to the current locale

Parameters

Returns

string

the translated string

Examples

const locales = {
  [LocaleType.EN_US]: {
    foo: {
      bar: 'Hello'
   }
}
t('foo.bar') => 'Hello'

const locales = {
  [LocaleType.EN_US]: {
    foo: {
      bar: 'Hello {0}'
   }
}
t('foo.bar', 'World') => 'Hello World'

Defined in

packages/core/src/services/locale/locale.service.ts:76 (opens in a new tab)