Class PropertyMap

A case-insensitive key-value container for audio metadata properties. Keys are normalised to uppercase (e.g. "TITLE", "ARTIST").

Mirrors the TagLib PropertyMap API. Each key maps to an ordered list of string values, allowing multi-valued tags such as multiple artists.

Index

Constructors

Accessors

Methods

addUnsupportedData clear contains entries erase get insert keys merge removeEmpty replace toString unsupportedData

Constructors

constructor

new PropertyMap(): PropertyMap
Returns PropertyMap

Accessors

size

get size(): number
The number of distinct keys in the map.

Returns number
- Defined in toolkit/propertyMap.ts:29

Methods

addUnsupportedData

addUnsupportedData(key: string): void
Records key as an unsupported tag field that this map cannot represent.
Parameters
- key: string
  The raw tag key to mark as unsupported.
Returns void
- Defined in toolkit/propertyMap.ts:122

clear

clear(): void
Remove all entries.

Returns void
- Defined in toolkit/propertyMap.ts:75

contains

contains(key: string): boolean
Check whether a key exists (case-insensitive).
Parameters
- key: string
Returns boolean
- Defined in toolkit/propertyMap.ts:50

entries

entries(): IterableIterator<[string, string[]]>
Iterate over all entries.

Returns IterableIterator<[string, string[]]>
- Defined in toolkit/propertyMap.ts:65

erase

erase(key: string): boolean
Remove a key. Returns true if the key existed.
Parameters
- key: string
Returns boolean
- Defined in toolkit/propertyMap.ts:60

get

get(key: string): string[] | undefined
Get values for a key, or undefined if not present.
Parameters
- key: string
Returns string[] | undefined
- Defined in toolkit/propertyMap.ts:55

insert

insert(key: string, values: string[]): void
Insert (append) values for a key.
Parameters
- key: string
- values: string[]
Returns void
- Defined in toolkit/propertyMap.ts:34

keys

keys(): IterableIterator<string>
Iterate over all keys.

Returns IterableIterator<string>
- Defined in toolkit/propertyMap.ts:70

merge

merge(other: PropertyMap): void
Merge another PropertyMap into this one (concatenating values).
Parameters
- other: PropertyMap
Returns void
- Defined in toolkit/propertyMap.ts:85

removeEmpty

removeEmpty(): void
Remove entries whose value arrays are empty.

Returns void
- Defined in toolkit/propertyMap.ts:97

replace

replace(key: string, values: string[]): void
Replace all values for a key.
Parameters
- key: string
- values: string[]
Returns void
- Defined in toolkit/propertyMap.ts:45

toString

toString(): string
Returns a human-readable representation of the map and unsupported keys.

Returns string
- Defined in toolkit/propertyMap.ts:131

unsupportedData

unsupportedData(): string[]
Returns a copy of the list of keys that could not be mapped to a standard property name.

Returns string[]
- Defined in toolkit/propertyMap.ts:113