Interface: MessageContext<T>

The message context.

Signature

export interface MessageContext<T = string>

Type Parameters

Name
T = string

Properties

Name	Type	Description
type	string	The message type to be handled by the message function.
values	Record<string, unknown>	The message values.

Methods

linked()

linked(key: Path, modifier?: string): MessageType<T>;

Resolve linked message.

Parameters

Name	Type	Description
key	Path	A message key
modifier	string	A modifier (optional)

Returns

MessageType<T> — A resolve message.

---

linked()

linked(key: Path, modifier?: string, type?: string): MessageType<T>;

Overloaded linked

Parameters

Name	Type	Description
key	Path	A message key
modifier	string	A modifier (optional)
type	string	A message type (optional)

Returns

MessageType<T> — A resolve message.

---

linked()

linked(key: Path, options?: LinkedOptions): MessageType<T>;

Overloaded linked

Parameters

Name	Type	Description
key	Path	A message key
options	LinkedOptions	An linked options (optional)

Returns

MessageType<T> — A resolve message.

---

list()

list(index: number): unknown;

Resolve message value from list.

Parameters

Name	Type	Description
index	number	An index of message values.

Returns

unknown — A resolved message value.

---

named()

named(key: string): unknown;

Resolve message value from named.

Parameters

Name	Type	Description
key	string	A key of message value.

Returns

unknown — A resolved message value.

---

plural()

plural(messages: T[]): T;

Resolve message with plural index.

Parameters

Name	Type	Description
messages	T[]	the messages, that is resolved with plural index with translation function.

Returns

T — A resolved message.

Tags

• @remarks — That's resolved with plural index with translation function.

Tags

• @VueI18nGeneral