Type Alias CreateSchemaInterface<M>

The interface that defines the methods of createOpenAPISchema class.

Template: T

The tuple type of user-defined status codes (T extends Readonly<UserDefinedStatusCode[]>).

type CreateSchemaInterface<M extends ResponsesConfig> = {
    createSchema<R extends RouteConfig>(route: R): R;
    createSchema<
        R extends RouteConfig,
        const T extends readonly UserDefinedStatusCode<M>[],
    >(
        route: R,
        statusCodes: NeverWrapper<UserDefinedStatusCode<M>, T>,
    ): MergeRouteResponses<R, M, T>;
}

Type Parameters

M extends ResponsesConfig
The user-defined status codes type (M extends ResponsesConfig).

Implemented by

ZodOpenAPISchema

Index

Methods

Methods

createSchema

createSchema<R extends RouteConfig>(route: R): R
Type Parameters
- R extends RouteConfig
Parameters
- route: R
Returns R
- Defined in types.ts:176
createSchema<
    R extends RouteConfig,
    const T extends readonly UserDefinedStatusCode<M>[],
>(
    route: R,
    statusCodes: NeverWrapper<UserDefinedStatusCode<M>, T>,
): MergeRouteResponses<R, M, T>
Type Parameters
- R extends RouteConfig
- const T extends readonly UserDefinedStatusCode<M>[]
Parameters
- route: R
- statusCodes: NeverWrapper<UserDefinedStatusCode<M>, T>
Returns MergeRouteResponses<R, M, T>
- Defined in types.ts:178