Beignet API reference
    Preparing search index...

    Interface LoggingConfig<Ctx>

    Logging hook configuration.

    interface LoggingConfig<Ctx> {
        logger?: Logger;
        onRequestEnd?: (
            args: {
                contract?: HttpContractConfig;
                ctx?: Ctx;
                durationMs: number;
                error?: unknown;
                req: HttpRequestLike;
                requestInfo: TrustedRequestInfo;
                res: { headers: HttpResponseHeaders; status: number };
            },
        ) => void;
        onRequestStart?: (
            args: {
                contract?: HttpContractConfig;
                ctx?: Ctx;
                req: HttpRequestLike;
                requestInfo: TrustedRequestInfo;
            },
        ) => void;
        requestIdHeader?: string;
    }

    Type Parameters

    • Ctx
    Index
    logger? onRequestEnd? onRequestStart? requestIdHeader?
    logger?: Logger

    Logger used when custom lifecycle callbacks are not provided.

    onRequestEnd?: (
        args: {
            contract?: HttpContractConfig;
            ctx?: Ctx;
            durationMs: number;
            error?: unknown;
            req: HttpRequestLike;
            requestInfo: TrustedRequestInfo;
            res: { headers: HttpResponseHeaders; status: number };
        },
    ) => void

    Custom request-end observer.

    onRequestStart?: (
        args: {
            contract?: HttpContractConfig;
            ctx?: Ctx;
            req: HttpRequestLike;
            requestInfo: TrustedRequestInfo;
        },
    ) => void

    Custom request-start observer.

    requestIdHeader?: string

    Response header name used to expose the request ID. Uses ctx.requestId when present, otherwise the server's request correlation ID.

    Settings
    Member Visibility

    On This Page
    Properties