Class MsgResource

A named collection of messages belonging to a MsgProject.

Resources inherit format defaults from their project, support translation loading (including pseudo-localization), and can serialize to plain data.

Hierarchy

Map<string, MsgMessage>
- MsgResource

Implements

MsgInterface

Index

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

`Readonly`size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly`[species]

"[species]": MapConstructor

Accessors

attributes

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

Returns MsgAttributes
Implementation of MsgInterface.attributes
- Defined in src/classes/MsgResource/MsgResource.ts:117
set attributes(attributes: MsgAttributes): void
Replaces the resource's locale and formatting metadata.
Parameters
- attributes: MsgAttributes
Returns void
Implementation of MsgInterface.attributes
- Defined in src/classes/MsgResource/MsgResource.ts:122

notes

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

Returns MsgNote[]
Implementation of MsgInterface.notes
- Defined in src/classes/MsgResource/MsgResource.ts:127
set notes(notes: MsgNote[]): void
Replaces the notes attached to this resource.
Parameters
- notes: MsgNote[]
Returns void
Implementation of MsgInterface.notes
- Defined in src/classes/MsgResource/MsgResource.ts:132

title

get title(): string
Title that identifies this resource within a project.

Returns string
- Defined in src/classes/MsgResource/MsgResource.ts:144
set title(title: string): void
Sets the title that identifies this resource within a project.
Parameters
- title: string
Returns void
- Defined in src/classes/MsgResource/MsgResource.ts:149

Methods

[iterator]

"[iterator]"(): MapIterator<[string, MsgMessage]>
Returns an iterable of entries in the map.

Returns MapIterator<[string, MsgMessage]>
Inherited from Map.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:143

add

add(
    key: string,
    value: string,
    attributes?: MsgAttributes,
    notes?: MsgNote[],
): MsgResource
Adds a message to this resource, merging resource attributes with any overrides.
Parameters
- key: string
- value: string
- Optionalattributes: MsgAttributes
- Optionalnotes: MsgNote[]
Returns MsgResource
This resource, for chaining.
- Defined in src/classes/MsgResource/MsgResource.ts:165

addNote

addNote(note: MsgNote): void
Appends a note to this resource.
Parameters
- note: MsgNote
Returns void
- Defined in src/classes/MsgResource/MsgResource.ts:139

clear

clear(): void
Returns void
Inherited from Map.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:20

delete

delete(key: string): boolean
Parameters
- key: string
Returns boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Inherited from Map.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:24

entries

entries(): MapIterator<[string, MsgMessage]>
Returns an iterable of key, value pairs for every entry in the map.

Returns MapIterator<[string, MsgMessage]>
Inherited from Map.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:148

forEach

forEach(
    callbackfn: (
        value: MsgMessage,
        key: string,
        map: Map<string, MsgMessage>,
    ) => void,
    thisArg?: any,
): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: (value: MsgMessage, key: string, map: Map<string, MsgMessage>) => void
- OptionalthisArg: any
Returns void
Inherited from Map.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:28

get

get(key: string): MsgMessage | undefined
Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.
Parameters
- key: string
Returns MsgMessage | undefined
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Inherited from Map.get
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:33

getData

getData(stripNotes?: boolean): MsgResourceData
Returns a plain data object for this resource and its messages.

Attributes that match the resource or project defaults are omitted where possible to keep the output compact.
Parameters
- stripNotes: boolean = false
  When true, notes are omitted from the result.
Returns MsgResourceData
- Defined in src/classes/MsgResource/MsgResource.ts:302

getProject

getProject(): MsgProject
Returns the project this resource belongs to.

Returns MsgProject
- Defined in src/classes/MsgResource/MsgResource.ts:156

getTranslation

getTranslation(lang: string): Promise<MsgResource>
Loads and applies translations for a locale via the project loader.

When lang is the project's pseudo-locale, returns a pseudo-localized copy without calling the loader.
Parameters
- lang: string
Returns Promise<MsgResource>

Throws
When the locale is unsupported or its language chain is empty.
- Defined in src/classes/MsgResource/MsgResource.ts:250

has

has(key: string): boolean
Parameters
- key: string
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Inherited from Map.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:37

keys

keys(): MapIterator<string>
Returns an iterable of keys in the map

Returns MapIterator<string>
Inherited from Map.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:153

set

set(key: string, value: MsgMessage): this
Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.
Parameters
- key: string
- value: MsgMessage
Returns this
Inherited from Map.set
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:41

toJSON

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

translate

translate(data: MsgResourceData): MsgResource
Builds a translated copy of this resource from translation data.

Messages present in the translation replace the source; missing keys keep the source message. Notes are carried over from the source.
Parameters
- data: MsgResourceData
Returns MsgResource

Throws
When the translation title does not match this resource.
- Defined in src/classes/MsgResource/MsgResource.ts:187

values

values(): MapIterator<MsgMessage>
Returns an iterable of values in the map

Returns MapIterator<MsgMessage>
Inherited from Map.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:158

`Static`create

create(data: MsgResourceData, project: MsgProject): MsgResource
Builds a resource from MsgResourceData and an owning project.

When messages is provided, each entry is added to the resource. When omitted, the resource starts empty.
Parameters
- data: MsgResourceData
- project: MsgProject
Returns MsgResource
- Defined in src/classes/MsgResource/MsgResource.ts:41

`Static`groupBy

groupBy<K, T>(
items: Iterable<T>,
keySelector: (item: T, index: number) => K,
): Map<K, T[]>
Groups members of an iterable according to the return value of the passed callback.
Type Parameters
- K
- T
Parameters
- items: Iterable<T>
  An iterable.
- keySelector: (item: T, index: number) => K
  A callback which will be invoked for each item in items.
Returns Map<K, T[]>
Inherited from Map.groupBy
- Defined in node_modules/typescript/lib/lib.es2024.collection.d.ts:25

Class MsgResource

Hierarchy

Implements

Index

Properties

Accessors

Methods

Properties

Readonly[toStringTag]

Readonlysize

Returns

Static Readonly[species]

Accessors

attributes

Returns MsgAttributes

Parameters

Returns void

notes

Returns MsgNote[]

Parameters

Returns void

title

Returns string

Parameters

Returns void

Methods

[iterator]

Returns MapIterator<[string, MsgMessage]>

add

Parameters

Returns MsgResource

addNote

Parameters

Returns void

clear

Returns void

delete

Parameters

Returns boolean

entries

Returns MapIterator<[string, MsgMessage]>

forEach

Parameters

Returns void

get

Parameters

Returns MsgMessage | undefined

getData

Parameters

Returns MsgResourceData

getProject

Returns MsgProject

getTranslation

Parameters

Returns Promise<MsgResource>

Throws

has

Parameters

Returns boolean

keys

Returns MapIterator<string>

set

Parameters

Returns this

toJSON

Parameters

Returns string

translate

Parameters

Returns MsgResource

Throws

values

Returns MapIterator<MsgMessage>

Staticcreate

Parameters

Returns MsgResource

StaticgroupBy

Type Parameters

Parameters

Returns Map<K, T[]>

`Readonly`[toStringTag]

`Readonly`size

`Static` `Readonly`[species]

`Static`create

`Static`groupBy