Beignet API reference
    Preparing search index...

    Type Alias RequestContextArgs<Ports>

    Arguments passed to the context.request factory after a route is matched.

    type RequestContextArgs<Ports extends AnyPorts = AnyPorts> = {
        contract?: HttpContractConfig;
        ports: Ports;
        req: HttpRequestLike;
        requestId: string;
        requestInfo: TrustedRequestInfo;
        trace: TraceContext;
    }

    Type Parameters

    Index
    contract? ports req requestId requestInfo trace
    contract?: HttpContractConfig

    Matched contract, when the request resolved to a registered route.

    ports: Ports

    Final app ports, including ports contributed by providers.

    req: HttpRequestLike

    Framework-neutral request.

    requestId: string

    Request correlation ID resolved by the server from the configured request ID header, or generated when the request did not send one.

    requestInfo: TrustedRequestInfo

    Request metadata resolved from the server's explicit trusted-proxy policy. Forwarding headers never affect this value unless createServer({ trustedProxy }) opts into them.

    trace: TraceContext

    W3C trace context resolved by the server from the incoming traceparent header, or generated when the request did not send one. Spread this into the context (...trace) to correlate downstream activity.

    Settings
    Member Visibility

    On This Page
    Properties