Documentation - v0.0.1
    Preparing search index...

    Interface Endpoint<T>

    A type representing an API endpoint with method, path, request body, path parameters, query parameters, and response type.

    type GetUserEndpoint = Endpoint<{
      method: "GET";
      path: "/users/:id";
      response: User;
      pathParams: { id: string };
      query: { includePosts: boolean };
    }>;
    interface Endpoint<
        T extends BaseEndpointWithOptionals = BaseEndpointWithOptionals,
    > {
        body: T["body"] & Body;
        method: T["method"];
        path: T["path"];
        pathParams: PathParams<T["path"]> & T["pathParams"];
        query: T["query"];
        response: T["response"];
    }

    Type Parameters

    • T extends BaseEndpointWithOptionals = BaseEndpointWithOptionals
    Index

    Properties

    body method path pathParams query response

    Properties

    body

    body: T["body"] & Body
    method: T["method"]
    path: T["path"]
    pathParams: PathParams<T["path"]> & T["pathParams"]
    query: T["query"]
    response: T["response"]

    Settings

    Member Visibility

    On This Page

    Properties