Interface TranslateFunction<Key>

Type Parameters

• Key = ResolveTranslationKey

  The valid translation keys. Defaults to string for loose typing, but can be set to a specific union of strings (e.g., via NestedKeys<Schema>) to enforce strict key validation and autocompletion.

• TranslateFunction(key: Key): string

  Returns the translation for the key.

  Parameters

  • key: Key

    The translation key.

  Returns string

• TranslateFunction(key: Key, defaultValue: string): string

  Returns the translation for the key or the default value if no translation exists.

  Parameters

  • key: Key

    The translation key.

  • defaultValue: string

    The default value.

  Returns string

• TranslateFunction(key: Key, args: Record<string, unknown>): string

  Returns the translation for the key. The translation is interpolated with the given arguments.

  Parameters

  • key: Key

    The translation key.

  • args: Record<string, unknown>

    The interpolation arguments.

  Returns string

• TranslateFunction(
      key: Key,
      defaultValue: string,
      args: Record<string, unknown>,
  ): string

  Returns the translation for the key or the default value if no translation exists. The translation is interpolated with the given arguments.

  Parameters

  • key: Key

    The translation key.

  • defaultValue: string

    The default value.

  • args: Record<string, unknown>

    The interpolation arguments.

  Returns string

• TranslateFunction(
      key: Key,
      defaultValue?: string | Record<string, unknown>,
      args?: Record<string, unknown>,
  ): string

  Returns the translation for the key or the default value if no translation exists. The translation is interpolated with the given arguments.

  Parameters

  • key: Key

    The translation key.

  • OptionaldefaultValue: string | Record<string, unknown>

    The default value.

  • Optionalargs: Record<string, unknown>

    The interpolation arguments.

  Returns string