Beignet API reference
    Preparing search index...

    Interface HandlerArgs<Ctx, C>

    Arguments passed to a route handler after request parsing and validation.

    interface HandlerArgs<Ctx, C extends HttpContractConfig> {
        body: InferSchemaOrFallback<C["body"]>;
        contract: C;
        ctx: Ctx;
        headers: InferHeaders<C>;
        path: InferSchemaOrFallback<C["pathParams"]>;
        query: InferSchemaOrFallback<C["query"]>;
        req: HttpRequestLike;
    }

    Type Parameters

    Index

    Properties

    body: InferSchemaOrFallback<C["body"]>

    Parsed request body.

    contract: C

    Matched contract config.

    ctx: Ctx

    Application context returned by createContext.

    headers: InferHeaders<C>

    Parsed request headers.

    path: InferSchemaOrFallback<C["pathParams"]>

    Parsed path parameters.

    query: InferSchemaOrFallback<C["query"]>

    Parsed query parameters.

    Framework-neutral request.