Interface ContextManager<Context>

Context manager interface

The context manager is responsible for managing the context and propagating it across the application.

interface ContextManager<Context> {
    active(): Context;
    fromMetadata(activeContext, metadata): Context;
    getMetadata(context): string;
    with<A>(context, fn): ReturnType<A>;
}

Type Parameters

  • Context = any

Methods

active fromMetadata getMetadata with

Methods

active

fromMetadata

  • fromMetadata(activeContext, metadata): Context

  • Creates a new context from a serialized version effectively linking the new context to the parent context.

    Parameters

    • activeContext: Context
    • metadata: string

    Returns Context

getMetadata

  • getMetadata(context): string

  • Returns a serialized version of the current context. The metadata is the mechanism used to propagate the context across a distributed application.

    Parameters

    Returns string

with

  • with<A>(context, fn): ReturnType<A>

  • Creates a new context and sets it as active for the fn passed as last argument

    Type Parameters

    • A extends ((...args) => any)

    Parameters

    Returns ReturnType<A>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc