vue-i18n / vue / ComponentCustomProperties

接口：ComponentCustomProperties

Vue I18n 的组件自定义属性

Vue I18n 注入

方法

$d()

调用签名

$d(value): string;

日期时间格式化

参数

参数	类型	描述
value	string | number | Date	一个值、时间戳数字或 Date 实例

返回值

string

格式化后的值

备注

如果在响应式上下文中使用，当语言环境更改时会重新评估。

在 I18nMode | Composition API 模式中，$d 由 app.config.globalProperties 注入。 输入/输出与 Composer 实例相同，并且它作用于 全局范围。有关详细信息，请参见 Composer#d | `Composer#d`。

调用签名

$d<Value, Key, DefinedDateTimeFormat, Keys, ResourceKeys>(value, key): string;

日期时间格式化

类型参数

类型参数	默认类型
Value extends string | number | Date	number
Key extends string	string
DefinedDateTimeFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>	RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>
Keys	IsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedDateTimeFormat[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never

参数

参数	类型	描述
value	Value	一个值、时间戳数字或 Date 实例
key	Key | ResourceKeys	日期时间格式的键

返回值

string

格式化后的值

备注

重载的 $d。详细信息请参见 $d 备注。

调用签名

$d<Value, Key, DefinedDateTimeFormat, Keys, ResourceKeys>(value, options): string;

日期时间格式化

类型参数

类型参数	默认类型
Value extends string | number | Date	number
Key extends string	string
DefinedDateTimeFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>	RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>
Keys	IsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedDateTimeFormat[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never

参数

参数	类型	描述
value	Value	一个值、时间戳数字或 Date 实例
options	DateTimeOptions<Key | ResourceKeys>	一个 options

返回值

string

格式化后的值

备注

重载的 $d。详细信息请参见 $d 备注。

调用签名

$d<Value, Key, DefinedDateTimeFormat, Keys, ResourceKeys>(
   value, 
   key, 
   locale): string;

日期时间格式化

类型参数

类型参数	默认类型
Value extends string | number | Date	number
Key extends string	string
DefinedDateTimeFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>	RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>
Keys	IsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedDateTimeFormat[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never

参数

参数	类型	描述
value	Value	一个值、时间戳数字或 Date 实例
key	Key | ResourceKeys	日期时间格式的键
locale	string	语言环境，可选，覆盖全局范围或本地范围的语言环境

返回值

string

格式化后的值

备注

重载的 $d。详细信息请参见 $d 备注。

调用签名

$d<Value, Key, DefinedDateTimeFormat, Keys, ResourceKeys, OptionsType>(
   value, 
   options, 
   locale): IsPart<OptionsType> extends true ? DateTimeFormatPart[] : string;

日期时间格式化

类型参数

类型参数	默认类型
Value extends number | Date	number
Key extends string	string
DefinedDateTimeFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>	RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>
Keys	IsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedDateTimeFormat[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never
OptionsType	DateTimeOptions<Key | ResourceKeys, string>

参数

参数	类型	描述
value	Value	一个值、时间戳数字或 Date 实例
options	OptionsType	一个 options
locale	string	语言环境，可选，覆盖全局范围或本地范围的语言环境

返回值

IsPart<OptionsType> extends true ? DateTimeFormatPart[] : string

格式化后的值

备注

重载的 $d。详细信息请参见 $d 备注。

---

$n()

调用签名

$n(value): string;

数字格式化

参数

参数	类型	描述
value	number	一个数字值

返回值

string

格式化后的值

备注

如果在响应式上下文中使用，当语言环境更改时会重新评估。

在 I18nMode | Composition API 模式中，$n 由 app.config.globalProperties 注入。 输入/输出与 Composer 实例相同，并且它作用于 全局范围。有关详细信息，请参见 Composer#n | `Composer.n`。

调用签名

$n<Key, DefinedNumberFormat, Keys, ResourceKeys>(value, key): string;

数字格式化

类型参数

类型参数	默认类型
Key extends string	string
DefinedNumberFormat extends RemoveIndexSignature<{ [key: string]: NumberFormatOptions; }>	RemoveIndexSignature<{ [key: string]: NumberFormatOptions; }>
Keys	IsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedNumberFormat[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never

参数

参数	类型	描述
value	number	一个数字值
key	Key | ResourceKeys	数字格式的键

返回值

string

格式化后的值

备注

重载的 $n。详细信息请参见 $n 备注。

调用签名

$n<Key, DefinedNumberFormat, Keys, ResourceKeys, OptionsType>(value, options): IsPart<OptionsType> extends true ? NumberFormatPart[] : string;

数字格式化

类型参数

类型参数	默认类型
Key extends string	string
DefinedNumberFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>	RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>
Keys	IsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedNumberFormat[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never
OptionsType	NumberOptions<Key | ResourceKeys, string>

参数

参数	类型	描述
value	number	一个数字值
options	OptionsType	一个选项，参见 NumberOptions

返回值

IsPart<OptionsType> extends true ? NumberFormatPart[] : string

格式化后的值

备注

重载的 $n。详细信息请参见 $n 备注。

调用签名

$n<Key, DefinedNumberFormat, Keys, ResourceKeys>(
   value, 
   key, 
   locale): string;

数字格式化

类型参数

类型参数	默认类型
Key extends string	string
DefinedNumberFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>	RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>
Keys	IsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedNumberFormat[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never

参数

参数	类型	描述
value	number	一个数字值
key	Key | ResourceKeys	数字格式的键
locale	string	语言环境，可选，覆盖全局范围或本地范围的语言环境

返回值

string

格式化后的值

备注

重载的 $n。详细信息请参见 $n 备注。

调用签名

$n<Key, DefinedNumberFormat, Keys, ResourceKeys, OptionsType>(
   value, 
   options, 
   locale): IsPart<OptionsType> extends true ? NumberFormatPart[] : string;

数字格式化

类型参数

类型参数	默认类型
Key extends string	string
DefinedNumberFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>	RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>
Keys	IsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedNumberFormat[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never
OptionsType	NumberOptions<Key | ResourceKeys, string>

参数

参数	类型	描述
value	number	一个数字值
options	OptionsType	一个选项，参见 NumberOptions
locale	string	语言环境，可选，覆盖全局范围或本地范围的语言环境

返回值

IsPart<OptionsType> extends true ? NumberFormatPart[] : string

格式化后的值

备注

重载的 $n。详细信息请参见 $n 备注。

---

$rt()

调用签名

$rt(message): string;

解析本地消息翻译

参数

参数	类型	描述
message	| VueMessageType | MessageFunction<VueMessageType>	要解析的目标本地消息。您需要指定由 $tm 返回的本地消息。

返回值

string

翻译后的消息

备注

如果在响应式上下文中使用，当语言环境更改时会重新评估。

在 I18nMode | Composition API 模式中，$rt 由 app.config.globalProperties 注入。 输入/输出与 Composer 相同，并且它作用于 全局范围。有关详细信息，请参见 Composer#rt | `Composer#rt`。

调用签名

$rt(
   message, 
   plural, 
   options?): string;

为复数解析本地消息翻译

参数

参数	类型	描述
message	| VueMessageType | MessageFunction<VueMessageType>	要解析的目标本地消息。您需要指定由 $tm 返回的本地消息。
plural	number	要获取的复数字符串。1 返回第一个。
options?	TranslateOptions<string>	翻译的附加 options

返回值

string

翻译后的消息

备注

重载的 $rt。详细信息请参见 $rt 备注。

调用签名

$rt(
   message, 
   list, 
   options?): string;

为列表插值解析本地消息翻译

参数

参数	类型	描述
message	| VueMessageType | MessageFunction<VueMessageType>	要解析的目标本地消息。您需要指定由 $tm 返回的本地消息。
list	unknown[]	列表插值的值。
options?	TranslateOptions<string>	翻译的附加 options

返回值

string

翻译后的消息

备注

重载的 $rt。详细信息请参见 $rt 备注。

调用签名

$rt(
   message, 
   named, 
   options?): string;

为命名插值解析本地消息翻译

参数

参数	类型	描述
message	| VueMessageType | MessageFunction<VueMessageType>	要解析的目标本地消息。您需要指定由 $tm 返回的本地消息。
named	NamedValue	命名插值的值。
options?	TranslateOptions<string>	翻译的附加 options

返回值

string

翻译后的消息

备注

重载的 $rt。详细信息请参见 $rt 备注。

---

$t()

调用签名

$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key): string;

本地消息翻译

类型参数

类型参数	默认类型
Key extends string	-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>	RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
Keys	IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never

参数

参数	类型	描述
key	number | Key | ResourceKeys	目标本地消息键

返回值

string

翻译后的消息

备注

如果在响应式上下文中使用，当语言环境更改时会重新评估。

在 I18nMode | Composition API 模式中，$t 由 app.config.globalProperties 注入。 输入/输出与 Composer 相同，并且它作用于 全局范围。有关详细信息，请参见 Composer#t | `Composer#t`。

调用签名

$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key, plural): string;

本地消息翻译

类型参数

类型参数	默认类型
Key extends string	-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>	RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
Keys	IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never

参数

参数	类型	描述
key	number | Key | ResourceKeys	目标本地消息键
plural	number	复数的选择数字

返回值

string

翻译后的消息

备注

重载的 $t。详细信息请参见 $t 备注。

调用签名

$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
   key, 
   plural, 
   options): string;

本地消息翻译

类型参数

类型参数	默认类型
Key extends string	-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>	RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
Keys	IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never

参数

参数	类型	描述
key	number | Key | ResourceKeys	目标本地消息键
plural	number	要获取的复数字符串。1 返回第一个。
options	TranslateOptions	一个选项，参见 TranslateOptions

返回值

string

翻译后的消息

备注

重载的 $t。详细信息请参见 $t 备注。

调用签名

$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key, defaultMsg): string;

本地消息翻译

类型参数

类型参数	默认类型
Key extends string	-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>	RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
Keys	IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never

参数

参数	类型	描述
key	number | Key | ResourceKeys	目标本地消息键
defaultMsg	string	如果未找到翻译，则返回的默认消息

返回值

string

翻译后的消息

备注

重载的 $t。详细信息请参见 $t 备注。

调用签名

$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
   key, 
   defaultMsg, 
   options): string;

本地消息翻译

类型参数

类型参数	默认类型
Key extends string	-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>	RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
Keys	IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never

参数

参数	类型	描述
key	number | Key | ResourceKeys	目标本地消息键
defaultMsg	string	如果未找到翻译，则返回的默认消息
options	TranslateOptions	一个选项，参见 TranslateOptions

返回值

string

翻译后的消息

备注

重载的 $t。详细信息请参见 $t 备注。

调用签名

$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key, list): string;

本地消息翻译

类型参数

类型参数	默认类型
Key extends string	-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>	RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
Keys	IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never

参数

参数	类型	描述
key	number | Key | ResourceKeys	目标本地消息键
list	unknown[]	列表插值的值

返回值

string

翻译后的消息

备注

重载的 $t。详细信息请参见 $t 备注。

调用签名

$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
   key, 
   list, 
   plural): string;

本地消息翻译

类型参数

类型参数	默认类型
Key extends string	-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>	RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
Keys	IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never

参数

参数	类型	描述
key	number | Key | ResourceKeys	目标本地消息键
list	unknown[]	列表插值的值
plural	number	复数的选择数字

返回值

string

翻译后的消息

备注

重载的 $t。详细信息请参见 $t 备注。

调用签名

$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
   key, 
   list, 
   defaultMsg): string;

本地消息翻译

类型参数

类型参数	默认类型
Key extends string	-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>	RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
Keys	IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never

参数

参数	类型	描述
key	number | Key | ResourceKeys	目标本地消息键
list	unknown[]	列表插值的值
defaultMsg	string	如果未找到翻译，则返回的默认消息

返回值

string

翻译后的消息

备注

重载的 $t。详细信息请参见 $t 备注。

调用签名

$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
   key, 
   list, 
   options): string;

本地消息翻译

类型参数

类型参数	默认类型
Key extends string	-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>	RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
Keys	IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never

参数

参数	类型	描述
key	number | Key | ResourceKeys	目标本地消息键
list	unknown[]	列表插值的值
options	TranslateOptions	一个选项，参见 TranslateOptions

返回值

string

翻译后的消息

备注

重载的 $t。详细信息请参见 $t 备注。

调用签名

$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key, named): string;

本地消息翻译

类型参数

类型参数	默认类型
Key extends string	-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>	RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
Keys	IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never

参数

参数	类型	描述
key	number | Key | ResourceKeys	目标本地消息键
named	NamedValue	命名插值的值

返回值

string

翻译后的消息

备注

重载的 $t。详细信息请参见 $t 备注。

调用签名

$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
   key, 
   named, 
   plural): string;

本地消息翻译

类型参数

类型参数	默认类型
Key extends string	-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>	RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
Keys	IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never

参数

参数	类型	描述
key	number | Key | ResourceKeys	目标本地消息键
named	NamedValue	命名插值的值
plural	number	复数的选择数字

返回值

string

翻译后的消息

备注

重载的 $t。详细信息请参见 $t 备注。

调用签名

$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
   key, 
   named, 
   defaultMsg): string;

本地消息翻译

类型参数

类型参数	默认类型
Key extends string	-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>	RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
Keys	IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never

参数

参数	类型	描述
key	number | Key | ResourceKeys	目标本地消息键
named	NamedValue	命名插值的值
defaultMsg	string	如果未找到翻译，则返回的默认消息

返回值

string

翻译后的消息

备注

重载的 $t。详细信息请参见 $t 备注。

调用签名

$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
   key, 
   named, 
   options): string;

本地消息翻译

类型参数

类型参数	默认类型
Key extends string	-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>	RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
Keys	IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never

参数

参数	类型	描述
key	number | Key | ResourceKeys	目标本地消息键
named	NamedValue	命名插值的值
options	TranslateOptions	一个选项，参见 TranslateOptions

返回值

string

翻译后的消息

备注

重载的 $t。详细信息请参见 $t 备注。

---

$te()

$te<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key, locale?): boolean;

翻译消息存在

类型参数

类型参数	默认类型
Key extends string	-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>	RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
Keys	IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never

参数

参数	类型	描述
key	Key | ResourceKeys	目标本地消息键
locale?	string	语言环境，可选，覆盖全局范围或本地范围的语言环境

返回值

boolean

如果找到本地消息则返回 true，否则返回 false，请注意即使键中的值不可翻译也会返回 false。

备注

有关详细信息，请参见 VueI18n#te | `VueI18n#te` 或 Composer#te | `Composer#te`。

---

$tm()

$tm<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key): 
  | {
}
  | LocaleMessageValue<VueMessageType>;

本地消息获取器

类型参数

类型参数	默认类型
Key extends string	-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>	RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
Keys	IsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeys	IsNever<Keys> extends false ? Keys : never

参数

参数	类型	描述
key	Key | ResourceKeys	目标本地消息键

返回值

| { } | LocaleMessageValue<VueMessageType>

本地消息

备注

在 I18nMode | Composition API 模式中，$tm 由 app.config.globalProperties 注入。 输入/输出与 Composer 实例相同，并且它作用于 全局范围。有关详细信息，请参见 Composer#tm | `Composer.tm`。 基于当前 locale，将从 Composer 实例消息中返回本地消息。 如果您更改了 locale，返回的本地消息也将对应该语言环境。 如果在 Composer 实例消息中没有给定 key 的本地消息，它们将以回退方式返回。

属性

$i18n

$i18n: ExportedGlobalComposer;

导出的全局 Composer 实例

备注

您可以获取从全局 Composer | 使用 createI18n 创建的 Composer 实例导出的 导出的 composer 实例 您可以在 I18nMode | Composition API 模式下获取导出的 composer 实例 由该属性引用的实例所管理的语言环境、本地消息和其他资源在全局范围内有效。 如果未指定 i18n 组件自定义选项，则与可以由 i18n 实例 I18n.global | 全局属性引用的 VueI18n 实例相同。