Documentation - v1.2.0-alpha.3
    Preparing search index...

    Interface HeaderPropagationCollection

    Defines the interface for managing header propagation.

    interface HeaderPropagationCollection {
        incoming: Record<string, string>;
        outgoing: Record<string, string>;
        add(headers: Record<string, string>): void;
        concat(headers: Record<string, string>): void;
        override(headers: Record<string, string>): void;
        propagate(headers: string[]): void;
    }

    Implemented by

    Index

    Properties

    incoming outgoing

    Methods

    add concat override propagate

    Properties

    incoming: Record<string, string>

    The collection of incoming headers from the incoming request.

    This collection is built based on the headers received in the request.

    outgoing: Record<string, string>

    The collection of headers that will be propagated to outgoing requests.

    This collection is built based on the incoming headers and the definition provided.

    Methods

    • Adds a header definition to the outgoing collection.

      Parameters

      • headers: Record<string, string>

        Headers to add to the outgoing collection.

      Returns void

      If the header already exists, it will not be added.

    • Concatenates a header definition to the outgoing collection.

      Parameters

      • headers: Record<string, string>

        Headers to concatenate to the outgoing collection.

      Returns void

      If the header does not exist in the incoming headers, it will be ignored. Unless the header is already present in the outgoing collection.

    • Overrides a header definition in the outgoing collection.

      Parameters

      • headers: Record<string, string>

        Headers to override in the outgoing collection.

      Returns void

      If the header does not exist in the incoming headers, it will be added to the outgoing collection.

    • Propagates the incoming header value to the outgoing collection based on the header definition key.

      Parameters

      • headers: string[]

        List of header keys to propagate.

      Returns void

      If the header does not exist in the incoming headers, it will be ignored.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods