Interface Baggage

Baggage represents collection of key-value pairs with optional metadata. Each key of Baggage is associated with exactly one value. Baggage may be used to annotate and enrich telemetry data.

since: 1.0.0

Hierarchy

Baggage

Index

Methods

Methods

clear

clear(): Baggage

- Defined in api/src/baggage/types.ts:103
Returns a new baggage with no entries

Returns Baggage

getAllEntries

getAllEntries(): [string, BaggageEntry][]

- Defined in api/src/baggage/types.ts:76
Get a list of all entries in the Baggage

Returns [string, BaggageEntry][]

getEntry

getEntry(key: string): undefined | BaggageEntry

- Defined in api/src/baggage/types.ts:71
Get an entry from Baggage if it exists

Parameters
- key: string
  
  The key which identifies the BaggageEntry
Returns undefined | BaggageEntry

removeEntries

removeEntries(...key: string[]): Baggage

- Defined in api/src/baggage/types.ts:98
Returns a new baggage with the entries from the current bag except the removed entries

Parameters
- Rest ...key: string[]
  
  keys identifying the entries to be removed
Returns Baggage

removeEntry

removeEntry(key: string): Baggage

- Defined in api/src/baggage/types.ts:91
Returns a new baggage with the entries from the current bag except the removed entry

Parameters
- key: string
  
  key identifying the entry to be removed
Returns Baggage

setEntry

setEntry(key: string, entry: BaggageEntry): Baggage

- Defined in api/src/baggage/types.ts:84
Returns a new baggage with the entries from the current bag and the specified entry

Parameters
- key: string
  
  string which identifies the baggage entry
- entry: BaggageEntry
  
  BaggageEntry for the given key
Returns Baggage

Generated using TypeDoc