API Reference
    Preparing search index...

    Type Alias InjectLambdaContextOptions

    Options for the () method.

    type InjectLambdaContextOptions = {
        clearState?: boolean;
        correlationIdPath?: string;
        flushBufferOnUncaughtError?: boolean;
        logEvent?: boolean;
        resetKeys?: boolean;
    }
    Index

    Properties

    clearState? correlationIdPath? flushBufferOnUncaughtError? logEvent? resetKeys?

    Properties

    clearState?: boolean

    Use ()` instead.

    correlationIdPath?: string

    The path to the correlation ID in the event object, used to extract the correlation ID from the event object and add it to the log attributes.

    flushBufferOnUncaughtError?: boolean

    Whether to flush the log buffer when an uncaught error is logged.

    false

    logEvent?: boolean

    When true the logger will log the event.

    To avoid logging sensitive information, we recommend using this option only for debugging purposes in local environments.

    resetKeys?: boolean

    If true, the logger will reset the keys added via ()

    Settings

    Member Visibility

    On This Page

    Properties