Interface: ComponentCustomProperties

Component Custom Properties for Vue I18n

Signature

export interface ComponentCustomProperties

Properties

Name	Type	Description
$i18n	ExportedGlobalComposer	Exported Global Composer instance

Methods

$d()

$d(value: number | Date | string): string;

Datetime formatting

Parameters

Name	Type	Description
value	number | Date | string	A value, timestamp number or Date instance

Returns

string — formatted value

Tags

• @remarks — If this is used in a reactive context, it will re-evaluate once the locale changes. In Composition API mode, the $d is injected by app.config.globalProperties. the input / output is the same as for Composer instance, and it work on global scope. About that details, see Composer#d.

---

$d()

$d<
    Value extends number | Date | string = number,
    Key extends string = string,
    DefinedDateTimeFormat extends RemovedIndexResources<DefineDateTimeFormat> =
      RemovedIndexResources<DefineDateTimeFormat>,
    Keys = IsEmptyObject<DefinedDateTimeFormat> extends false
      ? PickupFormatPathKeys<{
          [K in keyof DefinedDateTimeFormat]: DefinedDateTimeFormat[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
  >(value: Value, key: Key | ResourceKeys): string;

Datetime formatting

Type Parameters

Name
Value extends number | Date | string = number
Key extends string = string
DefinedDateTimeFormat extends RemovedIndexResources<DefineDateTimeFormat> = RemovedIndexResources<DefineDateTimeFormat>
Keys = IsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{ [K in keyof DefinedDateTimeFormat]: DefinedDateTimeFormat[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never

Parameters

Name	Type	Description
value	Value	A value, timestamp number or Date instance
key	Key | ResourceKeys	A key of datetime formats

Returns

string — formatted value

Tags

• @remarks — Overloaded $d. About details, see the $d remarks.

---

$d()

$d<
    Value extends number | Date | string = number,
    Key extends string = string,
    DefinedDateTimeFormat extends RemovedIndexResources<DefineDateTimeFormat> =
      RemovedIndexResources<DefineDateTimeFormat>,
    Keys = IsEmptyObject<DefinedDateTimeFormat> extends false
      ? PickupFormatPathKeys<{
          [K in keyof DefinedDateTimeFormat]: DefinedDateTimeFormat[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
  >(value: Value, options: DateTimeOptions<Key | ResourceKeys>): string;

Datetime formatting

Type Parameters

Name
Value extends number | Date | string = number
Key extends string = string
DefinedDateTimeFormat extends RemovedIndexResources<DefineDateTimeFormat> = RemovedIndexResources<DefineDateTimeFormat>
Keys = IsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{ [K in keyof DefinedDateTimeFormat]: DefinedDateTimeFormat[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never

Parameters

Name	Type	Description
value	Value	A value, timestamp number or Date instance
options	DateTimeOptions<Key | ResourceKeys>	An options

Returns

string — formatted value

Tags

• @remarks — Overloaded $d. About details, see the $d remarks.

---

$d()

$d<
    Value extends number | Date | string = number,
    Key extends string = string,
    DefinedDateTimeFormat extends RemovedIndexResources<DefineDateTimeFormat> =
      RemovedIndexResources<DefineDateTimeFormat>,
    Keys = IsEmptyObject<DefinedDateTimeFormat> extends false
      ? PickupFormatPathKeys<{
          [K in keyof DefinedDateTimeFormat]: DefinedDateTimeFormat[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
  >(value: Value, key: Key | ResourceKeys, locale: Locale): string;

Datetime formatting

Type Parameters

Name
Value extends number | Date | string = number
Key extends string = string
DefinedDateTimeFormat extends RemovedIndexResources<DefineDateTimeFormat> = RemovedIndexResources<DefineDateTimeFormat>
Keys = IsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{ [K in keyof DefinedDateTimeFormat]: DefinedDateTimeFormat[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never

Parameters

Name	Type	Description
value	Value	A value, timestamp number or Date instance
key	Key | ResourceKeys	A key of datetime formats
locale	Locale	A locale, optional, override locale that global scope or local scope

Returns

string — formatted value

Tags

• @remarks — Overloaded $d. About details, see the $d remarks.

---

$d()

$d<
    Value extends number | Date | string = number,
    Key extends string = string,
    DefinedDateTimeFormat extends RemovedIndexResources<DefineDateTimeFormat> =
      RemovedIndexResources<DefineDateTimeFormat>,
    Keys = IsEmptyObject<DefinedDateTimeFormat> extends false
      ? PickupFormatPathKeys<{
          [K in keyof DefinedDateTimeFormat]: DefinedDateTimeFormat[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never,
    OptionsType = DateTimeOptions<Key | ResourceKeys>
  >(value: Value, options: OptionsType, locale: Locale): IsPart<OptionsType> extends true ? Intl.DateTimeFormatPart[] : string;

Datetime formatting

Type Parameters

Name
Value extends number | Date | string = number
Key extends string = string
DefinedDateTimeFormat extends RemovedIndexResources<DefineDateTimeFormat> = RemovedIndexResources<DefineDateTimeFormat>
Keys = IsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{ [K in keyof DefinedDateTimeFormat]: DefinedDateTimeFormat[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
OptionsType = DateTimeOptions<Key | ResourceKeys>

Parameters

Name	Type	Description
value	Value	A value, timestamp number or Date instance
options	OptionsType	An options
locale	Locale	A locale, optional, override locale that global scope or local scope

Returns

IsPart<OptionsType> extends true ? Intl.DateTimeFormatPart[] : string — formatted value

Tags

• @remarks — Overloaded $d. About details, see the $d remarks.

---

$n()

$n(value: number): string;

Number formatting

Parameters

Name	Type	Description
value	number	A number value

Returns

string — formatted value

Tags

• @remarks — If this is used in a reactive context, it will re-evaluate once the locale changes. In Composition API mode, the $n is injected by app.config.globalProperties. the input / output is the same as for Composer instance, and it work on global scope. About that details, see Composer.n.

---

$n()

$n<
    Key extends string = string,
    DefinedNumberFormat extends RemovedIndexResources<DefineNumberFormat> =
      RemovedIndexResources<DefineNumberFormat>,
    Keys = IsEmptyObject<DefinedNumberFormat> extends false
      ? PickupFormatPathKeys<{
          [K in keyof DefinedNumberFormat]: DefinedNumberFormat[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
  >(value: number, key: Key | ResourceKeys): string;

Number formatting

Type Parameters

Name
Key extends string = string
DefinedNumberFormat extends RemovedIndexResources<DefineNumberFormat> = RemovedIndexResources<DefineNumberFormat>
Keys = IsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{ [K in keyof DefinedNumberFormat]: DefinedNumberFormat[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never

Parameters

Name	Type	Description
value	number	A number value
key	Key | ResourceKeys	A key of number formats

Returns

string — formatted value

Tags

• @remarks — Overloaded $n. About details, see the $n remarks.

---

$n()

$n<
    Key extends string = string,
    DefinedNumberFormat extends RemovedIndexResources<DefineNumberFormat> =
      RemovedIndexResources<DefineNumberFormat>,
    Keys = IsEmptyObject<DefinedNumberFormat> extends false
      ? PickupFormatPathKeys<{
          [K in keyof DefinedNumberFormat]: DefinedNumberFormat[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never,
    OptionsType = NumberOptions<Key | ResourceKeys>
  >(value: number, options: OptionsType): IsPart<OptionsType> extends true ? Intl.NumberFormatPart[] : string;

Number formatting

Type Parameters

Name
Key extends string = string
DefinedNumberFormat extends RemovedIndexResources<DefineNumberFormat> = RemovedIndexResources<DefineNumberFormat>
Keys = IsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{ [K in keyof DefinedNumberFormat]: DefinedNumberFormat[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
OptionsType = NumberOptions<Key | ResourceKeys>

Parameters

Name	Type	Description
value	number	A number value
options	OptionsType	An options, see the NumberOptions

Returns

IsPart<OptionsType> extends true ? Intl.NumberFormatPart[] : string — formatted value

Tags

• @remarks — Overloaded $n. About details, see the $n remarks.

---

$n()

$n<
    Key extends string = string,
    DefinedNumberFormat extends RemovedIndexResources<DefineNumberFormat> =
      RemovedIndexResources<DefineNumberFormat>,
    Keys = IsEmptyObject<DefinedNumberFormat> extends false
      ? PickupFormatPathKeys<{
          [K in keyof DefinedNumberFormat]: DefinedNumberFormat[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
  >(value: number, key: Key | ResourceKeys, locale: Locale): string;

Number formatting

Type Parameters

Name
Key extends string = string
DefinedNumberFormat extends RemovedIndexResources<DefineNumberFormat> = RemovedIndexResources<DefineNumberFormat>
Keys = IsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{ [K in keyof DefinedNumberFormat]: DefinedNumberFormat[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never

Parameters

Name	Type	Description
value	number	A number value
key	Key | ResourceKeys	A key of number formats
locale	Locale	A locale, optional, override locale that global scope or local scope

Returns

string — formatted value

Tags

• @remarks — Overloaded $n. About details, see the $n remarks.

---

$n()

$n<
    Key extends string = string,
    DefinedNumberFormat extends RemovedIndexResources<DefineNumberFormat> =
      RemovedIndexResources<DefineNumberFormat>,
    Keys = IsEmptyObject<DefinedNumberFormat> extends false
      ? PickupFormatPathKeys<{
          [K in keyof DefinedNumberFormat]: DefinedNumberFormat[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never,
    OptionsType = NumberOptions<Key | ResourceKeys>
  >(value: number, options: OptionsType, locale: Locale): IsPart<OptionsType> extends true ? Intl.NumberFormatPart[] : string;

Number formatting

Type Parameters

Name
Key extends string = string
DefinedNumberFormat extends RemovedIndexResources<DefineNumberFormat> = RemovedIndexResources<DefineNumberFormat>
Keys = IsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{ [K in keyof DefinedNumberFormat]: DefinedNumberFormat[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
OptionsType = NumberOptions<Key | ResourceKeys>

Parameters

Name	Type	Description
value	number	A number value
options	OptionsType	An options, see the NumberOptions
locale	Locale	A locale, optional, override locale that global scope or local scope

Returns

IsPart<OptionsType> extends true ? Intl.NumberFormatPart[] : string — formatted value

Tags

• @remarks — Overloaded $n. About details, see the $n remarks.

---

$rt()

$rt(message: MessageFunction<VueMessageType> | VueMessageType): string;

Resolve locale message translation

Parameters

Name	Type	Description
message	MessageFunction<VueMessageType> | VueMessageType	A target locale message to be resolved. You will need to specify the locale message returned by $tm.

Returns

string — translated message

Tags

• @remarks — If this is used in a reactive context, it will re-evaluate once the locale changes. In Composition API mode, the $rt is injected by app.config.globalProperties. the input / output is the same as for Composer, and it work on global scope. About that details, see Composer#rt.

---

$rt()

$rt(message: MessageFunction<VueMessageType> | VueMessageType, plural: number, options?: TranslateOptions): string;

Resolve locale message translation for plurals

Parameters

Name	Type	Description
message	MessageFunction<VueMessageType> | VueMessageType	A target locale message to be resolved. You will need to specify the locale message returned by $tm.
plural	number	Which plural string to get. 1 returns the first one.
options	TranslateOptions	Additional options for translation (optional)

Returns

string — Translated message

Tags

• @remarks — Overloaded $rt. About details, see the $rt remarks.

---

$rt()

$rt(message: MessageFunction<VueMessageType> | VueMessageType, list: unknown[], options?: TranslateOptions): string;

Resolve locale message translation for list interpolations

Parameters

Name	Type	Description
message	MessageFunction<VueMessageType> | VueMessageType	A target locale message to be resolved. You will need to specify the locale message returned by $tm.
list	unknown[]	A values of list interpolation.
options	TranslateOptions	Additional options for translation (optional)

Returns

string — Translated message

Tags

• @remarks — Overloaded $rt. About details, see the $rt remarks.

---

$rt()

$rt(message: MessageFunction<VueMessageType> | VueMessageType, named: NamedValue, options?: TranslateOptions): string;

Resolve locale message translation for named interpolations

Parameters

Name	Type	Description
message	MessageFunction<VueMessageType> | VueMessageType	A target locale message to be resolved. You will need to specify the locale message returned by $tm.
named	NamedValue	A values of named interpolation.
options	TranslateOptions	Additional options for translation (optional)

Returns

string — Translated message

Tags

• @remarks — Overloaded $rt. About details, see the $rt remarks.

---

$t()

$t<
    DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> =
      RemovedIndexResources<DefineLocaleMessage>,
    Keys = IsEmptyObject<DefinedLocaleMessage> extends false
      ? JsonPaths<{
          [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
  >(key: ResourceKeys | (string & {}) | number): string;

Locale message translation

Type Parameters

Name
DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> = RemovedIndexResources<DefineLocaleMessage>
Keys = IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never

Parameters

Name	Type	Description
key	ResourceKeys | (string & {}) | number	A target locale message key

Returns

string — translation message

Tags

• @remarks — If this is used in a reactive context, it will re-evaluate once the locale changes. In Composition API mode, the $t is injected by app.config.globalProperties. the input / output is the same as for Composer, and it work on global scope. About that details, see Composer#t.

---

$t()

$t<
    DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> =
      RemovedIndexResources<DefineLocaleMessage>,
    Keys = IsEmptyObject<DefinedLocaleMessage> extends false
      ? JsonPaths<{
          [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
  >(key: ResourceKeys | (string & {}) | number, plural: number): string;

Locale message translation

Type Parameters

Name
DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> = RemovedIndexResources<DefineLocaleMessage>
Keys = IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never

Parameters

Name	Type	Description
key	ResourceKeys | (string & {}) | number	A target locale message key
plural	number	A choice number of plural

Returns

string — translation message

Tags

• @remarks — Overloaded $t. About details, see the $t remarks.

---

$t()

$t<
    DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> =
      RemovedIndexResources<DefineLocaleMessage>,
    Keys = IsEmptyObject<DefinedLocaleMessage> extends false
      ? JsonPaths<{
          [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
  >(key: ResourceKeys | (string & {}) | number, plural: number, options: TranslateOptions): string;

Locale message translation

Type Parameters

Name
DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> = RemovedIndexResources<DefineLocaleMessage>
Keys = IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never

Parameters

Name	Type	Description
key	ResourceKeys | (string & {}) | number	A target locale message key
plural	number	Which plural string to get. 1 returns the first one.
options	TranslateOptions	An options, see the TranslateOptions

Returns

string — translation message

Tags

• @remarks — Overloaded $t. About details, see the $t remarks.

---

$t()

$t<
    DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> =
      RemovedIndexResources<DefineLocaleMessage>,
    Keys = IsEmptyObject<DefinedLocaleMessage> extends false
      ? JsonPaths<{
          [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
  >(key: ResourceKeys | (string & {}) | number, defaultMsg: string): string;

Locale message translation

Type Parameters

Name
DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> = RemovedIndexResources<DefineLocaleMessage>
Keys = IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never

Parameters

Name	Type	Description
key	ResourceKeys | (string & {}) | number	A target locale message key
defaultMsg	string	A default message to return if no translation was found

Returns

string — translation message

Tags

• @remarks — Overloaded $t. About details, see the $t remarks.

---

$t()

$t<
    DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> =
      RemovedIndexResources<DefineLocaleMessage>,
    Keys = IsEmptyObject<DefinedLocaleMessage> extends false
      ? JsonPaths<{
          [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
  >(key: ResourceKeys | (string & {}) | number, defaultMsg: string, options: TranslateOptions): string;

Locale message translation

Type Parameters

Name
DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> = RemovedIndexResources<DefineLocaleMessage>
Keys = IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never

Parameters

Name	Type	Description
key	ResourceKeys | (string & {}) | number	A target locale message key
defaultMsg	string	A default message to return if no translation was found
options	TranslateOptions	An options, see the TranslateOptions

Returns

string — translation message

Tags

• @remarks — Overloaded $t. About details, see the $t remarks.

---

$t()

$t<
    DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> =
      RemovedIndexResources<DefineLocaleMessage>,
    Keys = IsEmptyObject<DefinedLocaleMessage> extends false
      ? JsonPaths<{
          [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
  >(key: ResourceKeys | (string & {}) | number, list: unknown[]): string;

Locale message translation

Type Parameters

Name
DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> = RemovedIndexResources<DefineLocaleMessage>
Keys = IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never

Parameters

Name	Type	Description
key	ResourceKeys | (string & {}) | number	A target locale message key
list	unknown[]	A values of list interpolation

Returns

string — translation message

Tags

• @remarks — Overloaded $t. About details, see the $t remarks.

---

$t()

$t<
    DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> =
      RemovedIndexResources<DefineLocaleMessage>,
    Keys = IsEmptyObject<DefinedLocaleMessage> extends false
      ? JsonPaths<{
          [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
  >(key: ResourceKeys | (string & {}) | number, list: unknown[], plural: number): string;

Locale message translation

Type Parameters

Name
DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> = RemovedIndexResources<DefineLocaleMessage>
Keys = IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never

Parameters

Name	Type	Description
key	ResourceKeys | (string & {}) | number	A target locale message key
list	unknown[]	A values of list interpolation
plural	number	A choice number of plural

Returns

string — translation message

Tags

• @remarks — Overloaded $t. About details, see the $t remarks.

---

$t()

$t<
    DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> =
      RemovedIndexResources<DefineLocaleMessage>,
    Keys = IsEmptyObject<DefinedLocaleMessage> extends false
      ? JsonPaths<{
          [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
  >(key: ResourceKeys | (string & {}) | number, list: unknown[], defaultMsg: string): string;

Locale message translation

Type Parameters

Name
DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> = RemovedIndexResources<DefineLocaleMessage>
Keys = IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never

Parameters

Name	Type	Description
key	ResourceKeys | (string & {}) | number	A target locale message key
list	unknown[]	A values of list interpolation
defaultMsg	string	A default message to return if no translation was found

Returns

string — translation message

Tags

• @remarks — Overloaded $t. About details, see the $t remarks.

---

$t()

$t<
    DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> =
      RemovedIndexResources<DefineLocaleMessage>,
    Keys = IsEmptyObject<DefinedLocaleMessage> extends false
      ? JsonPaths<{
          [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
  >(key: ResourceKeys | (string & {}) | number, list: unknown[], options: TranslateOptions): string;

Locale message translation

Type Parameters

Name
DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> = RemovedIndexResources<DefineLocaleMessage>
Keys = IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never

Parameters

Name	Type	Description
key	ResourceKeys | (string & {}) | number	A target locale message key
list	unknown[]	A values of list interpolation
options	TranslateOptions	An options, see the TranslateOptions

Returns

string — translation message

Tags

• @remarks — Overloaded $t. About details, see the $t remarks.

---

$t()

$t<
    DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> =
      RemovedIndexResources<DefineLocaleMessage>,
    Keys = IsEmptyObject<DefinedLocaleMessage> extends false
      ? JsonPaths<{
          [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
  >(key: ResourceKeys | (string & {}) | number, named: NamedValue): string;

Locale message translation

Type Parameters

Name
DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> = RemovedIndexResources<DefineLocaleMessage>
Keys = IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never

Parameters

Name	Type	Description
key	ResourceKeys | (string & {}) | number	A target locale message key
named	NamedValue	A values of named interpolation

Returns

string — translation message

Tags

• @remarks — Overloaded $t. About details, see the $t remarks.

---

$t()

$t<
    DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> =
      RemovedIndexResources<DefineLocaleMessage>,
    Keys = IsEmptyObject<DefinedLocaleMessage> extends false
      ? JsonPaths<{
          [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
  >(key: ResourceKeys | (string & {}) | number, named: NamedValue, plural: number): string;

Locale message translation

Type Parameters

Name
DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> = RemovedIndexResources<DefineLocaleMessage>
Keys = IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never

Parameters

Name	Type	Description
key	ResourceKeys | (string & {}) | number	A target locale message key
named	NamedValue	A values of named interpolation
plural	number	A choice number of plural

Returns

string — translation message

Tags

• @remarks — Overloaded $t. About details, see the $t remarks.

---

$t()

$t<
    DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> =
      RemovedIndexResources<DefineLocaleMessage>,
    Keys = IsEmptyObject<DefinedLocaleMessage> extends false
      ? JsonPaths<{
          [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
  >(key: ResourceKeys | (string & {}) | number, named: NamedValue, defaultMsg: string): string;

Locale message translation

Type Parameters

Name
DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> = RemovedIndexResources<DefineLocaleMessage>
Keys = IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never

Parameters

Name	Type	Description
key	ResourceKeys | (string & {}) | number	A target locale message key
named	NamedValue	A values of named interpolation
defaultMsg	string	A default message to return if no translation was found

Returns

string — translation message

Tags

• @remarks — Overloaded $t. About details, see the $t remarks.

---

$t()

$t<
    DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> =
      RemovedIndexResources<DefineLocaleMessage>,
    Keys = IsEmptyObject<DefinedLocaleMessage> extends false
      ? JsonPaths<{
          [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
  >(key: ResourceKeys | (string & {}) | number, named: NamedValue, options: TranslateOptions): string;

Locale message translation

Type Parameters

Name
DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> = RemovedIndexResources<DefineLocaleMessage>
Keys = IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never

Parameters

Name	Type	Description
key	ResourceKeys | (string & {}) | number	A target locale message key
named	NamedValue	A values of named interpolation
options	TranslateOptions	An options, see the TranslateOptions

Returns

string — translation message

Tags

• @remarks — Overloaded $t. About details, see the $t remarks.

---

$te()

$te<
    Key extends string,
    DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> =
      RemovedIndexResources<DefineLocaleMessage>,
    Keys = IsEmptyObject<DefinedLocaleMessage> extends false
      ? JsonPaths<{
          [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
  >(key: Key | ResourceKeys, locale?: Locale): boolean;

Translation message exist

Type Parameters

Name
Key extends string
DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> = RemovedIndexResources<DefineLocaleMessage>
Keys = IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never

Parameters

Name	Type	Description
key	Key | ResourceKeys	A target locale message key
locale	Locale	A locale, optional, override locale that global scope or local scope (optional)

Returns

boolean — If found locale message, true, else false, Note that false is returned even if the value present in the key is not translatable.

Tags

• @remarks — About that details, see VueI18n#te or Composer#te.

---

$tm()

$tm<
    Key extends string,
    DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> =
      RemovedIndexResources<DefineLocaleMessage>,
    Keys = IsEmptyObject<DefinedLocaleMessage> extends false
      ? JsonPaths<{
          [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K]
        }>
      : never,
    ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never
  >(key: Key | ResourceKeys): LocaleMessageValue<VueMessageType> | {};

Locale messages getter

Type Parameters

Name
Key extends string
DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> = RemovedIndexResources<DefineLocaleMessage>
Keys = IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K] }> : never
ResourceKeys extends Keys = IsNever<Keys> extends false ? Keys : never

Parameters

Name	Type	Description
key	Key | ResourceKeys	A target locale message key

Returns

LocaleMessageValue<VueMessageType> | {} — locale messages

Tags

• @remarks — In Composition API mode, the $tm is injected by app.config.globalProperties. the input / output is the same as for Composer instance, and it work on global scope. About that details, see Composer.tm. Based on the current locale, locale messages will be returned from Composer instance messages. If you change the locale, the locale messages returned will also correspond to the locale. If there are no locale messages for the given key in the composer instance messages, they will be returned with fallbacking.

Tags

• @VueI18nInjection