Interface UserMetadata

User-defined metadata attached to sink messages. Contains read-only user information organized by groups.

interface UserMetadata {
    getGroups(): string[];
    getKeys(group: string): string[];
    getValue(group: string, key: string): Buffer;
}

Index

Methods

getGroups getKeys getValue

Methods

getGroups

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

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

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:949

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:956