@opentelemetry/core/dist/propagation/composite.d.cts

OpenTelemetry Core provides constants and utilities shared by all OpenTelemetry SDK packages.

import { Context, TextMapGetter, TextMapPropagator, TextMapSetter } from "@opentelemetry/api";
//#region src/propagation/composite.d.ts
/** Configuration object for composite propagator */
interface CompositePropagatorConfig {
  /**
   * List of propagators to run. Propagators run in the
   * list order. If a propagator later in the list writes the same context
   * key as a propagator earlier in the list, the later on will "win".
   */
  propagators?: TextMapPropagator[];
}
/** Combines multiple propagators into a single propagator. */
declare class CompositePropagator implements TextMapPropagator {
  private readonly _propagators;
  private readonly _fields;
  /**
   * Construct a composite propagator from a list of propagators.
   *
   * @param [config] Configuration object for composite propagator
   */
  constructor(config?: CompositePropagatorConfig);
  /**
   * Run each of the configured propagators with the given context and carrier.
   * Propagators are run in the order they are configured, so if multiple
   * propagators write the same carrier key, the propagator later in the list
   * will "win".
   *
   * @param context Context to inject
   * @param carrier Carrier into which context will be injected
   */
  inject(context: Context, carrier: unknown, setter: TextMapSetter): void;
  /**
   * Run each of the configured propagators with the given context and carrier.
   * Propagators are run in the order they are configured, so if multiple
   * propagators write the same context key, the propagator later in the list
   * will "win".
   *
   * @param context Context to add values to
   * @param carrier Carrier from which to extract context
   */
  extract(context: Context, carrier: unknown, getter: TextMapGetter): Context;
  fields(): string[];
}
//#endregion
export { CompositePropagator, CompositePropagatorConfig };
//# sourceMappingURL=composite.d.cts.map