Beignet API reference
    Preparing search index...

    Type Alias AuthHookArgs<Ctx, HeadersSchema>

    Arguments passed to auth route-hook callbacks.

    type AuthHookArgs<
        Ctx,
        HeadersSchema extends StandardSchema | undefined = undefined,
    > = {
        body: unknown;
        contract: { metadata?: Record<string, unknown> };
        ctx: Ctx;
        headers: HeadersSchema extends StandardSchema
            ? InferOutput<HeadersSchema>
            : Record<string, string>;
        path: unknown;
        query: unknown;
        req: HttpRequestLike;
    }

    Type Parameters

    Index
    body: unknown

    Parsed request body.

    contract: { metadata?: Record<string, unknown> }

    Matched contract metadata and schemas.

    ctx: Ctx

    Current route handler context.

    headers: HeadersSchema extends StandardSchema
        ? InferOutput<HeadersSchema>
        : Record<string, string>

    Hook-owned request headers.

    When the auth hooks declare a headers schema, this is that schema's output parsed from the raw lowercase request header record. Without a schema it is the raw lowercase header record itself, so auth resolution never depends on each route's contract header schema.

    path: unknown

    Parsed path parameters.

    query: unknown

    Parsed query parameters.

    Framework-neutral request.