Skip to content

Interface: ComposerTranslation<Messages, Locales, DefinedLocaleMessage, C, M, ResourceKeys>

Locale message translation functions

Signature

ts
export interface ComposerTranslation<
  Messages extends Record<string, any> = {},
  Locales = 'en-US',
  DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> =
    RemovedIndexResources<DefineLocaleMessage>,
  C = IsEmptyObject<DefinedLocaleMessage> extends false
    ? JsonPaths<{
        [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K]
      }>
    : never,
  M = IsEmptyObject<Messages> extends false ? TranslationsPaths<Messages> : never,
  ResourceKeys extends C | M = IsNever<C> extends false
    ? IsNever<M> extends false
      ? C | M
      : C
    : IsNever<M> extends false
      ? M
      : never
>

Type Parameters

Name
Messages extends Record<string, any> = {}
Locales = 'en-US'
DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> = RemovedIndexResources<DefineLocaleMessage>
C = IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K] }> : never
M = IsEmptyObject<Messages> extends false ? TranslationsPaths<Messages> : never
ResourceKeys extends C | M = IsNever<C> extends false ? IsNever<M> extends false ? C | M : C : IsNever<M> extends false ? M : never

Tags

  • @VueI18nComposition
  • @remarks — This is the interface for Composer

Released under the MIT License.