Interface TextMapGetter<Carrier>

A getter is specified by the caller to define a specific method to get the value of a key from a carrier.

Since

1.0.0

interface TextMapGetter<Carrier = any> {
get(carrier: Carrier, key: string): string | string[] | undefined;
keys(carrier: Carrier): string[];
}

Type Parameters

Carrier = any

Implemented by

EnvironmentGetter

Index

Methods

Methods

get

get(carrier: Carrier, key: string): string | string[] | undefined
Get the value of a specific key from the carrier.
Parameters
- carrier: Carrier
- key: string
Returns string | string[] | undefined
- Defined in propagation/TextMapPropagator.ts:108

keys

keys(carrier: Carrier): string[]
Get a list of all keys available on the carrier.
Parameters
- carrier: Carrier
Returns string[]
- Defined in propagation/TextMapPropagator.ts:100