Class MsgMessage

A single localizable message with a key, value, attributes, and notes.

Supports MessageFormat 1, MessageFormat 2, and unformatted (NONE) strings.

Implements

MsgInterface

Index

Accessors

attributes key notes value

Methods

addNote format formatToParts getData toJSON toString create

Accessors

attributes

get attributes(): MsgAttributes
Locale and formatting metadata for this message.

Returns MsgAttributes
Implementation of MsgInterface.attributes
- Defined in src/classes/MsgMessage/MsgMessage.ts:68

key

get key(): string
Unique key that identifies this message within a resource.

Returns string
- Defined in src/classes/MsgMessage/MsgMessage.ts:58

notes

get notes(): MsgNote[]
Notes attached to this message for translators and tooling.

Returns MsgNote[]
Implementation of MsgInterface.notes
- Defined in src/classes/MsgMessage/MsgMessage.ts:73

value

get value(): string
The message string, possibly in MessageFormat syntax.

Returns string
- Defined in src/classes/MsgMessage/MsgMessage.ts:63

Methods

addNote

addNote(note: MsgNote): void
Appends a note to this message.
Parameters
- note: MsgNote
Returns void
- Defined in src/classes/MsgMessage/MsgMessage.ts:80

format

format(
data: Record<string, any>,
options?: MessageFormatOptions<never, never>,
): string
Formats the message with the given placeholder data.

For NONE format messages, returns the raw value unchanged.
Parameters
- data: Record<string, any>
- Optionaloptions: MessageFormatOptions<never, never>
Returns string
- Defined in src/classes/MsgMessage/MsgMessage.ts:108

formatToParts

formatToParts(
data: Record<string, any>,
options?: MessageFormatOptions<never, never>,
): MessagePart<never>[]
Formats the message into structured parts with the given placeholder data.

For NONE format messages, returns a single text part with the raw value.
Parameters
- data: Record<string, any>
- Optionaloptions: MessageFormatOptions<never, never>
Returns MessagePart<never>[]
- Defined in src/classes/MsgMessage/MsgMessage.ts:121

getData

getData(
    stripNotes?: boolean,
): {
    attributes: MsgAttributes;
    key: string;
    notes: MsgNote[] | undefined;
    value: string;
}
Returns a plain data object for this message.
Parameters
- stripNotes: boolean = false
  When true, notes are omitted from the result.
Returns {
    attributes: MsgAttributes;
    key: string;
    notes: MsgNote[] | undefined;
    value: string;
}
- Defined in src/classes/MsgMessage/MsgMessage.ts:134

toJSON

toJSON(stripNotes?: boolean): string
Serializes this message to a formatted JSON string.
Parameters
- stripNotes: boolean = false
  When true, notes are omitted from the serialized data.
Returns string
- Defined in src/classes/MsgMessage/MsgMessage.ts:155

toString

toString(): string
Returns the message value as a string.

Returns string
- Defined in src/classes/MsgMessage/MsgMessage.ts:146

`Static`create

create(data: MsgMessageData): MsgMessage
Builds a message from MsgMessageData.
Parameters
- data: MsgMessageData
Returns MsgMessage
- Defined in src/classes/MsgMessage/MsgMessage.ts:51