Interface UserMetadata

User-defined metadata that can be attached to messages. Allows storing arbitrary key-value pairs organized by groups.

Example

const metadata = new map.UserMetadata();
metadata.createGroup('tracking');
metadata.addKv('tracking', 'source', Buffer.from('api'));
metadata.addKv('tracking', 'version', Buffer.from('1.0'));

interface UserMetadata {
    addKv(group: string, key: string, value: Buffer): void;
    createGroup(group: string): void;
    getGroups(): string[];
    getKeys(group: string): string[];
    getValue(group: string, key: string): Buffer;
    removeGroup(group: string): void;
    removeKey(group: string, key: string): void;
}

Index

Methods

addKv createGroup getGroups getKeys getValue removeGroup removeKey

Methods

addKv

addKv(group: string, key: string, value: Buffer): void
Add a key-value pair to a group.
Parameters
- group: string
  The group name
- key: string
  The key name
- value: Buffer
  The value as a Buffer
Returns void
- Defined in index.ts:683

createGroup

createGroup(group: string): void
Create a new group in the metadata.
Parameters
- group: string
  The group name to create
Returns void
- Defined in index.ts:676

getGroups

getGroups(): string[]
Get all group names in the metadata.

Returns string[]
Array of group names
- Defined in index.ts:658

getKeys

getKeys(group: string): string[]
Get all keys within a specific group.
Parameters
- group: string
  The group name
Returns string[]
Array of key names in the group
- Defined in index.ts:664

getValue

getValue(group: string, key: string): Buffer
Get the value for a specific key within a group.
Parameters
- group: string
  The group name
- key: string
  The key name
Returns Buffer
The value as a Buffer
- Defined in index.ts:671

removeGroup

removeGroup(group: string): void
Remove an entire group from the metadata.
Parameters
- group: string
  The group name to remove
Returns void
- Defined in index.ts:694

removeKey

removeKey(group: string, key: string): void
Remove a key from a group.
Parameters
- group: string
  The group name
- key: string
  The key to remove
Returns void
- Defined in index.ts:689

Interface UserMetadata

Example

Index

Methods

Methods

addKv

Parameters

Returns void

createGroup

Parameters

Returns void

getGroups

Returns string[]

getKeys

Parameters

Returns string[]

getValue

Parameters

Returns Buffer

removeGroup

Parameters

Returns void

removeKey

Parameters

Returns void

Settings

On This Page