Class EndpointBuilder<TResponse, TParams, TQuery, TBody, TState, TRequestHeaders, TResponseHeaders, TStatusResponses>

Type Parameters

TResponse = unknown
TParams extends Params | undefined = undefined
TQuery extends Query | undefined = undefined
TBody extends Body | undefined = undefined
TState extends State = State
TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined
TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined
TStatusResponses extends ResponseStatusMap | undefined = undefined

Index

Constructors

constructor

Methods

bodyOf build paramsOf queryOf requestHeadersOf responseHeadersOf responseOf responsesOf stateOf

Constructors

constructor

new EndpointBuilder<
    TResponse = unknown,
    TParams extends string | undefined = undefined,
    TQuery extends Query = undefined,
    TBody extends Body | undefined = undefined,
    TState extends State = State,
    TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined,
    TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined,
    TStatusResponses extends ResponseStatusMap | undefined = undefined,
>(
    api: Api,
): EndpointBuilder<
    TResponse,
    TParams,
    TQuery,
    TBody,
    TState,
    TRequestHeaders,
    TResponseHeaders,
    TStatusResponses,
>
Type Parameters
- TResponse = unknown
- TParams extends string | undefined = undefined
- TQuery extends Query = undefined
- TBody extends Body | undefined = undefined
- TState extends State = State
- TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined
- TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined
- TStatusResponses extends ResponseStatusMap | undefined = undefined
Parameters
- api: Api
Returns EndpointBuilder<
    TResponse,
    TParams,
    TQuery,
    TBody,
    TState,
    TRequestHeaders,
    TResponseHeaders,
    TStatusResponses,
>
- Defined in src/EndpointBuilder.ts:67

Methods

bodyOf

bodyOf<TNewBody extends Body>(
    options?: BodyValidationOptions<TNewBody>,
): EndpointBuilder<
    TResponse,
    TParams,
    TQuery,
    TNewBody,
    TState,
    TRequestHeaders,
    TResponseHeaders,
    TStatusResponses,
>
Type Parameters
- TNewBody extends Body
Parameters
- Optionaloptions: BodyValidationOptions<TNewBody>
Returns EndpointBuilder<
    TResponse,
    TParams,
    TQuery,
    TNewBody,
    TState,
    TRequestHeaders,
    TResponseHeaders,
    TStatusResponses,
>
- Defined in src/EndpointBuilder.ts:115
bodyOf<TNewBody extends Body>(
    schema?: ZodType<
        TNewBody,
        unknown,
        $ZodTypeInternals<TNewBody, unknown>,
    >,
): EndpointBuilder<
    TResponse,
    TParams,
    TQuery,
    TNewBody,
    TState,
    TRequestHeaders,
    TResponseHeaders,
    TStatusResponses,
>
Type Parameters
- TNewBody extends Body
Parameters
- Optionalschema: ZodType<TNewBody, unknown, $ZodTypeInternals<TNewBody, unknown>>
Returns EndpointBuilder<
    TResponse,
    TParams,
    TQuery,
    TNewBody,
    TState,
    TRequestHeaders,
    TResponseHeaders,
    TStatusResponses,
>

Deprecated
Pass { schema } instead.
- Defined in src/EndpointBuilder.ts:121

build

build<TPath extends string, TResponseType extends ResponseType>(
    options: EndpointBuildOptions<
        TResponse,
        TParams,
        TQuery,
        TBody,
        TState,
        TRequestHeaders,
        TResponseHeaders,
        TPath,
        TResponseType,
    >,
): Endpoint<
    unknown extends TResponse ? DefaultResponseOf<TResponseType> : TResponse,
    TParams,
    TQuery,
    TBody,
    TState,
    TPath,
    TRequestHeaders,
    TResponseHeaders,
    TStatusResponses,
>
Type Parameters
- TPath extends string
- TResponseType extends ResponseType
Parameters
- options: EndpointBuildOptions<
      TResponse,
      TParams,
      TQuery,
      TBody,
      TState,
      TRequestHeaders,
      TResponseHeaders,
      TPath,
      TResponseType,
  >
Returns Endpoint<
    unknown extends TResponse ? DefaultResponseOf<TResponseType> : TResponse,
    TParams,
    TQuery,
    TBody,
    TState,
    TPath,
    TRequestHeaders,
    TResponseHeaders,
    TStatusResponses,
>
- Defined in src/EndpointBuilder.ts:252

paramsOf

paramsOf<TNewParams extends string>(): EndpointBuilder<
    TResponse,
    TNewParams,
    TQuery,
    TBody,
    TState,
    TRequestHeaders,
    TResponseHeaders,
    TStatusResponses,
>
Type Parameters
- TNewParams extends string
Returns EndpointBuilder<
    TResponse,
    TNewParams,
    TQuery,
    TBody,
    TState,
    TRequestHeaders,
    TResponseHeaders,
    TStatusResponses,
>
- Defined in src/EndpointBuilder.ts:102

queryOf

queryOf<TNewQuery extends Query>(
    options?: ValidationOptions<TNewQuery>,
): EndpointBuilder<
    TResponse,
    TParams,
    TNewQuery,
    TBody,
    TState,
    TRequestHeaders,
    TResponseHeaders,
    TStatusResponses,
>
Type Parameters
- TNewQuery extends Query
Parameters
- Optionaloptions: ValidationOptions<TNewQuery>
Returns EndpointBuilder<
    TResponse,
    TParams,
    TNewQuery,
    TBody,
    TState,
    TRequestHeaders,
    TResponseHeaders,
    TStatusResponses,
>
- Defined in src/EndpointBuilder.ts:71
queryOf<TNewQuery extends Query>(
    schema?: ZodType<
        TNewQuery,
        unknown,
        $ZodTypeInternals<TNewQuery, unknown>,
    >,
): EndpointBuilder<
    TResponse,
    TParams,
    TNewQuery,
    TBody,
    TState,
    TRequestHeaders,
    TResponseHeaders,
    TStatusResponses,
>
Type Parameters
- TNewQuery extends Query
Parameters
- Optionalschema: ZodType<TNewQuery, unknown, $ZodTypeInternals<TNewQuery, unknown>>
Returns EndpointBuilder<
    TResponse,
    TParams,
    TNewQuery,
    TBody,
    TState,
    TRequestHeaders,
    TResponseHeaders,
    TStatusResponses,
>

Deprecated
Pass { schema } instead.
- Defined in src/EndpointBuilder.ts:77

requestHeadersOf

requestHeadersOf<TNewRequestHeaders extends RawHeaders>(): EndpointBuilder<
    TResponse,
    TParams,
    TQuery,
    TBody,
    TState,
    TNewRequestHeaders,
    TResponseHeaders,
    TStatusResponses,
>
Type Parameters
- TNewRequestHeaders extends RawHeaders
Returns EndpointBuilder<
    TResponse,
    TParams,
    TQuery,
    TBody,
    TState,
    TNewRequestHeaders,
    TResponseHeaders,
    TStatusResponses,
>
- Defined in src/EndpointBuilder.ts:226

responseHeadersOf

responseHeadersOf<TNewResponseHeaders extends RawHeaders>(): EndpointBuilder<
    TResponse,
    TParams,
    TQuery,
    TBody,
    TState,
    TRequestHeaders,
    TNewResponseHeaders,
    TStatusResponses,
>
Type Parameters
- TNewResponseHeaders extends RawHeaders
Returns EndpointBuilder<
    TResponse,
    TParams,
    TQuery,
    TBody,
    TState,
    TRequestHeaders,
    TNewResponseHeaders,
    TStatusResponses,
>
- Defined in src/EndpointBuilder.ts:239

responseOf

responseOf<TNewResponse>(
    options?: ValidationOptions<TNewResponse>,
): EndpointBuilder<
    TNewResponse,
    TParams,
    TQuery,
    TBody,
    TState,
    TRequestHeaders,
    TResponseHeaders,
    undefined,
>
Type Parameters
- TNewResponse
Parameters
- Optionaloptions: ValidationOptions<TNewResponse>
Returns EndpointBuilder<
    TNewResponse,
    TParams,
    TQuery,
    TBody,
    TState,
    TRequestHeaders,
    TResponseHeaders,
    undefined,
>
- Defined in src/EndpointBuilder.ts:148
responseOf<TNewResponse>(
    schema?: ZodType<
        TNewResponse,
        unknown,
        $ZodTypeInternals<TNewResponse, unknown>,
    >,
): EndpointBuilder<
    TNewResponse,
    TParams,
    TQuery,
    TBody,
    TState,
    TRequestHeaders,
    TResponseHeaders,
    undefined,
>
Type Parameters
- TNewResponse
Parameters
- Optionalschema: ZodType<TNewResponse, unknown, $ZodTypeInternals<TNewResponse, unknown>>
Returns EndpointBuilder<
    TNewResponse,
    TParams,
    TQuery,
    TBody,
    TState,
    TRequestHeaders,
    TResponseHeaders,
    undefined,
>

Deprecated
Pass { schema } instead.
- Defined in src/EndpointBuilder.ts:154

responsesOf

responsesOf<TNewResponses extends ResponseStatusMap>(
    options: StatusResponseValidationOptions<TNewResponses>,
): EndpointBuilder<
    TNewResponses[keyof TNewResponses],
    TParams,
    TQuery,
    TBody,
    TState,
    TRequestHeaders,
    TResponseHeaders,
    TNewResponses,
>
Type Parameters
- TNewResponses extends ResponseStatusMap
Parameters
- options: StatusResponseValidationOptions<TNewResponses>
Returns EndpointBuilder<
    TNewResponses[keyof TNewResponses],
    TParams,
    TQuery,
    TBody,
    TState,
    TRequestHeaders,
    TResponseHeaders,
    TNewResponses,
>
- Defined in src/EndpointBuilder.ts:172

stateOf

stateOf<TNewState extends State>(
    options?: ValidationOptions<TNewState>,
): EndpointBuilder<
    TResponse,
    TParams,
    TQuery,
    TBody,
    TNewState,
    TRequestHeaders,
    TResponseHeaders,
    TStatusResponses,
>
Type Parameters
- TNewState extends State
Parameters
- Optionaloptions: ValidationOptions<TNewState>
Returns EndpointBuilder<
    TResponse,
    TParams,
    TQuery,
    TBody,
    TNewState,
    TRequestHeaders,
    TResponseHeaders,
    TStatusResponses,
>
- Defined in src/EndpointBuilder.ts:195
stateOf<TNewState extends State>(
    schema?: ZodType<
        TNewState,
        unknown,
        $ZodTypeInternals<TNewState, unknown>,
    >,
): EndpointBuilder<
    TResponse,
    TParams,
    TQuery,
    TBody,
    TNewState,
    TRequestHeaders,
    TResponseHeaders,
    TStatusResponses,
>
Type Parameters
- TNewState extends State
Parameters
- Optionalschema: ZodType<TNewState, unknown, $ZodTypeInternals<TNewState, unknown>>
Returns EndpointBuilder<
    TResponse,
    TParams,
    TQuery,
    TBody,
    TNewState,
    TRequestHeaders,
    TResponseHeaders,
    TStatusResponses,
>

Deprecated
Pass { schema } instead.
- Defined in src/EndpointBuilder.ts:201

Class EndpointBuilder<TResponse, TParams, TQuery, TBody, TState, TRequestHeaders, TResponseHeaders, TStatusResponses>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns EndpointBuilder< TResponse, TParams, TQuery, TBody, TState, TRequestHeaders, TResponseHeaders, TStatusResponses,>

Methods

bodyOf

Type Parameters

Parameters

Returns EndpointBuilder< TResponse, TParams, TQuery, TNewBody, TState, TRequestHeaders, TResponseHeaders, TStatusResponses,>

Type Parameters

Parameters

Returns EndpointBuilder< TResponse, TParams, TQuery, TNewBody, TState, TRequestHeaders, TResponseHeaders, TStatusResponses,>

Deprecated

build

Type Parameters

Parameters

Returns Endpoint< unknown extends TResponse ? DefaultResponseOf<TResponseType> : TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders, TStatusResponses,>

paramsOf

Type Parameters

Returns EndpointBuilder< TResponse, TNewParams, TQuery, TBody, TState, TRequestHeaders, TResponseHeaders, TStatusResponses,>

queryOf

Type Parameters

Parameters

Returns EndpointBuilder< TResponse, TParams, TNewQuery, TBody, TState, TRequestHeaders, TResponseHeaders, TStatusResponses,>

Type Parameters

Parameters

Returns EndpointBuilder< TResponse, TParams, TNewQuery, TBody, TState, TRequestHeaders, TResponseHeaders, TStatusResponses,>

Deprecated

requestHeadersOf

Type Parameters

Returns EndpointBuilder< TResponse, TParams, TQuery, TBody, TState, TNewRequestHeaders, TResponseHeaders, TStatusResponses,>

responseHeadersOf

Type Parameters

Returns EndpointBuilder< TResponse, TParams, TQuery, TBody, TState, TRequestHeaders, TNewResponseHeaders, TStatusResponses,>

responseOf

Type Parameters

Parameters

Returns EndpointBuilder< TNewResponse, TParams, TQuery, TBody, TState, TRequestHeaders, TResponseHeaders, undefined,>

Type Parameters

Parameters

Returns EndpointBuilder< TNewResponse, TParams, TQuery, TBody, TState, TRequestHeaders, TResponseHeaders, undefined,>

Deprecated

responsesOf

Type Parameters

Parameters

Returns EndpointBuilder< TNewResponses[keyof TNewResponses], TParams, TQuery, TBody, TState, TRequestHeaders, TResponseHeaders, TNewResponses,>

stateOf

Type Parameters

Parameters

Returns EndpointBuilder< TResponse, TParams, TQuery, TBody, TNewState, TRequestHeaders, TResponseHeaders, TStatusResponses,>

Type Parameters

Parameters

Returns EndpointBuilder< TResponse, TParams, TQuery, TBody, TNewState, TRequestHeaders, TResponseHeaders, TStatusResponses,>

Deprecated

Settings

On This Page

Returns EndpointBuilder<
TResponse,
TParams,
TQuery,
TBody,
TState,
TRequestHeaders,
TResponseHeaders,
TStatusResponses,
>

Returns EndpointBuilder<
TResponse,
TParams,
TQuery,
TNewBody,
TState,
TRequestHeaders,
TResponseHeaders,
TStatusResponses,
>

Returns EndpointBuilder<
TResponse,
TParams,
TQuery,
TNewBody,
TState,
TRequestHeaders,
TResponseHeaders,
TStatusResponses,
>

Returns Endpoint<
unknown extends TResponse ? DefaultResponseOf<TResponseType> : TResponse,
TParams,
TQuery,
TBody,
TState,
TPath,
TRequestHeaders,
TResponseHeaders,
TStatusResponses,
>

Returns EndpointBuilder<
TResponse,
TNewParams,
TQuery,
TBody,
TState,
TRequestHeaders,
TResponseHeaders,
TStatusResponses,
>

Returns EndpointBuilder<
TResponse,
TParams,
TNewQuery,
TBody,
TState,
TRequestHeaders,
TResponseHeaders,
TStatusResponses,
>

Returns EndpointBuilder<
TResponse,
TParams,
TNewQuery,
TBody,
TState,
TRequestHeaders,
TResponseHeaders,
TStatusResponses,
>

Returns EndpointBuilder<
TResponse,
TParams,
TQuery,
TBody,
TState,
TNewRequestHeaders,
TResponseHeaders,
TStatusResponses,
>

Returns EndpointBuilder<
TResponse,
TParams,
TQuery,
TBody,
TState,
TRequestHeaders,
TNewResponseHeaders,
TStatusResponses,
>

Returns EndpointBuilder<
TNewResponse,
TParams,
TQuery,
TBody,
TState,
TRequestHeaders,
TResponseHeaders,
undefined,
>

Returns EndpointBuilder<
TNewResponse,
TParams,
TQuery,
TBody,
TState,
TRequestHeaders,
TResponseHeaders,
undefined,
>

Returns EndpointBuilder<
TNewResponses[keyof TNewResponses],
TParams,
TQuery,
TBody,
TState,
TRequestHeaders,
TResponseHeaders,
TNewResponses,
>

Returns EndpointBuilder<
TResponse,
TParams,
TQuery,
TBody,
TNewState,
TRequestHeaders,
TResponseHeaders,
TStatusResponses,
>

Returns EndpointBuilder<
TResponse,
TParams,
TQuery,
TBody,
TNewState,
TRequestHeaders,
TResponseHeaders,
TStatusResponses,
>