Class TextLocalizerService

A service to offer text alternatives to the default text based on cultureId.

It supports having fallbacks, so the app can have a standard implementation and another that introduces special cases.

To set that up:

let vs = createValidationServices(); // provides the standard case in vs.textLocalizerService
let special = new TextLocalizerService();
special.fallbackService = vs.textLocalizerService;
vs.textLocalizerService = special;

This implementation is independent of third party libraries that you may be using. Thus, you may prefer to implement ITextLocalizerService yourself.

There are two text values associated with localization:

A lookup key. A short code that maps to the actual string for each culture.
Fallback text. The text supplied when the lookup key does not have anything to offer for the given culture.

Hierarchy (view full)

ServiceBase
- TextLocalizerService

Implements

ITextLocalizerService

Index

Constructors

constructor

new TextLocalizerService(): TextLocalizerService
Returns TextLocalizerService
Inherited from ServiceBase.constructor

Accessors

serviceName

get serviceName(): string
Returns string
Implementation of ITextLocalizerService.serviceName
Inherited from ServiceBase.serviceName
- Defined in packages/jivs-engine/src/Services/ServiceBase.ts:19

fallbackService

get fallbackService(): null | ITextLocalizerService
Reference to a fallback of the same service or null if no fallback. When assigned, a call to any function (except registration) will first try itself, and if not found, try the fallback.

Returns null | ITextLocalizerService
Implementation of ITextLocalizerService.fallbackService
- Defined in packages/jivs-engine/src/Services/TextLocalizerService.ts:54
set fallbackService(service): void
Reference to a fallback of the same service or null if no fallback.
Parameters
- service: null | ITextLocalizerService
Returns void
Implementation of ITextLocalizerService.fallbackService
- Defined in packages/jivs-engine/src/Services/TextLocalizerService.ts:58

lazyLoad

set lazyLoad(fn): void
Sets up a function to lazy load the configuration when the localize() function tries and fails to match a request.
Parameters
- fn: ((service) => void)
  - - (service): void
    - Parameters
      service: TextLocalizerService
      Returns void
Returns void
- Defined in packages/jivs-engine/src/Services/TextLocalizerService.ts:325

Methods

dispose

dispose(): void
Participates in releasing memory. While not required, the idea is to be a more friendly participant in the ecosystem. Note that once called, expect null reference errors to be thrown if any other functions try to use them.

Returns void
Implementation of ITextLocalizerService.dispose
Overrides ServiceBase.dispose
- Defined in packages/jivs-engine/src/Services/TextLocalizerService.ts:42

localize

localize(cultureIdToMatch, l10nKey, fallback): null | string
Returns the localized version of the text for the given culture. Will try the language from the culture ('en' from 'en-US') and a code called '' to be used as a general fallback. You will have to register the '' code along with your language code translations if you want support of ''. service.Register('TRUE', { '': 'true', 'en': 'true', 'es': 'verdadero' }); If nothing is matched, it returns the fallback text.
Parameters
- cultureIdToMatch: string
  It will only use the language code part, like 'en' in 'en-US'. It will always attempt to match to '*' if the language code doesn't match.
- l10nKey: null | string
  Localization key, which is the text that identifies which word, phrase, or other block of text is requested. If '' or null, no localization is requested.
- fallback: null | string
  Used when there was no match for the culture or '*'. Only supply '' if you are sure that registered data will always supply a value.
Returns null | string
The localized text or the fallback text.
Implementation of ITextLocalizerService.localize
- Defined in packages/jivs-engine/src/Services/TextLocalizerService.ts:85

localizeWithDetails

localizeWithDetails(cultureIdToMatch, l10nKey, fallback): LocalizedDetailsResult
Localizes the given text with additional details. See localize() for more information. This targets the ConfigAnalysis.
Parameters
- cultureIdToMatch: string
  The culture ID to match for localization.
- l10nKey: null | string
  The localization key.
- fallback: null | string
  The fallback text to use if localization fails.
Returns LocalizedDetailsResult
An object containing the localized text, localization result, requested culture ID, and actual culture ID.
Implementation of ITextLocalizerService.localizeWithDetails
- Defined in packages/jivs-engine/src/Services/TextLocalizerService.ts:122

getErrorMessage

getErrorMessage(cultureIdToMatch, errorCode, dataTypeLookupKey): null | string
Attempts to get the localized error message for the ErrorCode and optional DataTypeLookupKey. If dataTypeLookupKey is supplied and no match is found, it tries with just the ErrorCode.
Parameters
- cultureIdToMatch: string
- errorCode: string
  same as ConditionType unless you set the ValidatorConfig.errorCode property
- dataTypeLookupKey: null | string
Returns null | string
The error message or null if not available.
Implementation of ITextLocalizerService.getErrorMessage
- Defined in packages/jivs-engine/src/Services/TextLocalizerService.ts:173

`Protected` getErrorMessagel10nText

getErrorMessagel10nText(errorCode, dataTypeLookupKey): string
Constructs the l10nText for the Error Message.
Parameters
- errorCode: string
  same as ConditionType unless you set the ValidatorConfig.errorCode property
- dataTypeLookupKey: null | string
Returns string
- Defined in packages/jivs-engine/src/Services/TextLocalizerService.ts:188

getSummaryMessage

getSummaryMessage(cultureIdToMatch, errorCode, dataTypeLookupKey): null | string
Attempts to get the localized Summary error message for the ErrorCode and optional DataTypeLookupKey If dataTypeLookupKey is supplied and no match is found, it tries with just the ErrorCode.
Parameters
- cultureIdToMatch: string
- errorCode: string
  same as ConditionType unless you set the ValidatorConfig.errorCode property
- dataTypeLookupKey: null | string
Returns null | string
The Summary error message or null if not available.
Implementation of ITextLocalizerService.getSummaryMessage
- Defined in packages/jivs-engine/src/Services/TextLocalizerService.ts:203

`Protected` getSummaryMessagel10nText

getSummaryMessagel10nText(errorCode, dataTypeLookupKey): string
Constructs the l10nText for the Summary error message.
Parameters
- errorCode: string
  same as ConditionType unless you set the ValidatorConfig.errorCode property
- dataTypeLookupKey: null | string
Returns string
- Defined in packages/jivs-engine/src/Services/TextLocalizerService.ts:218

getDataTypeLabel

getDataTypeLabel(cultureIdToMatch, dataTypeLookupKey): null | string
Attempts to get the localized name for a data type lookup key to be used in {DataType} token of error messages.
Parameters
- cultureIdToMatch: string
- dataTypeLookupKey: string
Returns null | string
The name or null if not available.
Implementation of ITextLocalizerService.getDataTypeLabel
- Defined in packages/jivs-engine/src/Services/TextLocalizerService.ts:231

`Protected` getDataTypeNamel10nText

getDataTypeNamel10nText(dataTypeLookupKey): string
Parameters
- dataTypeLookupKey: string
Returns string
- Defined in packages/jivs-engine/src/Services/TextLocalizerService.ts:241

register

register(l10nKey, cultureToText): void
Registers a lookup key with the culture specific text. Replaces an already registered entry with the same l10nKey.
Parameters
- l10nKey: string
  Localization key, which is the text that identifies which word, phrase, or other block of text is requested.
- cultureToText: CultureToText
  keys are language codes from cultureId, like 'en'. values are the actual text to output.
Returns void
Implementation of ITextLocalizerService.register
- Defined in packages/jivs-engine/src/Services/TextLocalizerService.ts:254

registerErrorMessage

registerErrorMessage(errorCode, dataTypeLookupKey, cultureToText): void
Utility to add an error message for a validator. The localization key (l10ntext) will use this pattern: 'EM-' + ErrorCode + '-' + DataTypeLookupKey 'EM-' + ErrorCode // this is a fallback
Parameters
- errorCode: string
  same as ConditionType unless you set the ValidatorConfig.errorCode property
- dataTypeLookupKey: null | string
  optional.
- cultureToText: CultureToText
Returns void
Implementation of ITextLocalizerService.registerErrorMessage
- Defined in packages/jivs-engine/src/Services/TextLocalizerService.ts:268

registerSummaryMessage

registerSummaryMessage(errorCode, dataTypeLookupKey, cultureToText): void
Utility to add a summary error message for a validator The localization key (l10ntext) will use this pattern: 'SEM-' + ErrorCode + '-' + DataTypeLookupKey 'SEM-' + ErrorCode // this is a fallback
Parameters
- errorCode: string
  same as ConditionType unless you set the ValidatorConfig.errorCode property
- dataTypeLookupKey: null | string
  optional.
- cultureToText: CultureToText
Returns void
Implementation of ITextLocalizerService.registerSummaryMessage
- Defined in packages/jivs-engine/src/Services/TextLocalizerService.ts:281

registerDataTypeLabel

registerDataTypeLabel(dataTypeLookupKey, cultureToText): void
Utility to add text representation of a data type associating it with its dataTypeLookupKey. The text is used with the {DataType} token in error messages. The localization key (l10ntext) will use this pattern: 'DTLK-' + DataTypeLookupKey
Parameters
- dataTypeLookupKey: string
- cultureToText: CultureToText
Returns void
Implementation of ITextLocalizerService.registerDataTypeLabel
- Defined in packages/jivs-engine/src/Services/TextLocalizerService.ts:294

`Protected` ensureLazyLoaded

ensureLazyLoaded(): boolean
Runs the lazyload function if setup and returns true if run.

Returns boolean
- Defined in packages/jivs-engine/src/Services/TextLocalizerService.ts:336

Class TextLocalizerService

Hierarchy (view full)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns TextLocalizerService

Accessors

serviceName

Returns string

fallbackService

Returns null | ITextLocalizerService

Parameters

Returns void

lazyLoad

Parameters

Parameters

Returns void

Returns void

Methods

dispose

Returns void

localize

Parameters

Returns null | string

localizeWithDetails

Parameters

Returns LocalizedDetailsResult

getErrorMessage

Parameters

Returns null | string

Protected getErrorMessagel10nText

Parameters

Returns string

getSummaryMessage

Parameters

Returns null | string

Protected getSummaryMessagel10nText

Parameters

Returns string

getDataTypeLabel

Parameters

Returns null | string

Protected getDataTypeNamel10nText

Parameters

Returns string

register

Parameters

Returns void

registerErrorMessage

Parameters

Returns void

registerSummaryMessage

Parameters

Returns void

registerDataTypeLabel

Parameters

Returns void

Protected ensureLazyLoaded

Returns boolean

Settings

Member Visibility

Theme

On This Page

`Protected` getErrorMessagel10nText

`Protected` getSummaryMessagel10nText

`Protected` getDataTypeNamel10nText

`Protected` ensureLazyLoaded