boundfetch
    Preparing search index...

    Interface EndpointDef

    Runtime contract for an endpoint exposed by a BoundFetch client.

    Schemas are optional for params, query, and body, but response is always required. When schemas are provided, input/output types are inferred from Zod.

    interface EndpointDef {
        body?: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>;
        expectJsonResponse?: boolean;
        headers?: Record<string, string>;
        method: HttpMethod;
        params?: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>;
        path: string;
        query?: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>;
        response: ZodType;
    }
    Index

    Properties

    body? expectJsonResponse? headers? method params? path query? response

    Properties

    Optionalbody

    body?: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
    expectJsonResponse?: boolean
    headers?: Record<string, string>
    method: HttpMethod
    params?: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
    path: string
    query?: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
    response: ZodType

    Settings

    Member Visibility

    On This Page

    Properties