Type Alias CreateContractOptions<TMethod, TPath>

Options for creating one contract with createContract(...).

type CreateContractOptions<
    TMethod extends HttpMethod = HttpMethod,
    TPath extends string = string,
> = {
    method: TMethod;
    name?: string;
    path: TPath;
}

Type Parameters

TMethod extends HttpMethod = HttpMethod
TPath extends string = string

Index

Properties

method name? path

Properties

method

method: TMethod

HTTP method (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS)

`Optional`name

name?: string

Optional contract name (auto-generated from method + path if not provided)

path

path: TPath

URL path template (e.g., "/api/users/:id")