API Reference
    Preparing search index...

    Interface ConfigServiceInterface

    This class defines common methods and variables that can be set by the developer in the runtime.

    Use utility constructor options and POWERTOOLS_* environment variables instead.

    interface ConfigServiceInterface {
        get(name: string): string;
        getServiceName(): string;
        getXrayTraceId(): string | undefined;
        getXrayTraceSampled(): boolean;
        isDevMode(): boolean;
        isValueTrue(value: string): boolean;
    }
    Index
    get getServiceName getXrayTraceId getXrayTraceSampled isDevMode isValueTrue

    • Get the value of an environment variable by name.

      Parameters

      • name: string

        The name of the environment variable to fetch.

      Returns string

    • Get the value of the _X_AMZN_TRACE_ID environment variable.

      The AWS X-Ray Trace data available in the environment variable has this format: Root=1-5759e988-bd862e3fe1be46a994272793;Parent=557abcec3ee5a047;Sampled=1,

      The actual Trace ID is: 1-5759e988-bd862e3fe1be46a994272793.

      Returns string | undefined

    • Determine if the current invocation is part of a sampled X-Ray trace.

      The AWS X-Ray Trace data available in the environment variable has this format: Root=1-5759e988-bd862e3fe1be46a994272793;Parent=557abcec3ee5a047;Sampled=1,

      Returns boolean

    • Helper function to determine if a value is considered thruthy.

      Parameters

      • value: string

        The value to check for truthiness.

      Returns boolean

    Settings
    Member Visibility

    On This Page
    Methods