Cerces

Appearance

Cerces

Cerces / routing / Route

Class: Route<PsBase, Ps, R> ​

Defined in: src/routing.ts:89

Represents a route declaration in the routing system.

This class encapsulates all the configuration and metadata for a single HTTP route, including its method, path, handler, parameters, responses, and OpenAPI schema information.

Type Parameters ​

PsBase ​

PsBase extends GenericRouteParameters<PsBase> = { }

The route parameters type inherited from parent routers or apps.

Ps ​

Ps extends GenericRouteParameters<Ps> = { }

The route parameters type specific to this route.

R ​

R = unknown

The response type returned by the route handler.

Constructors ​

Constructor ​

new Route<PsBase, Ps, R>(init): Route<PsBase, Ps, R>

Defined in: src/routing.ts:110

Parameters ​

init ​
method ​

HTTPMethod

path ​

string

name? ​

string

tags? ​

string[]

summary? ​

string

description? ​

string

deprecated? ​

boolean

responses? ​

Record<number, ResponseConfig>

security? ​

SecurityRequirementObject[]

includeInSchema? ​

boolean

statusCode? ​

number

responseClass? ​

ResponseClass

middleware? ​

Middleware[]

parameters? ​

Ps & DisallowDependencyParameters<ImplicitParameters<Ps>> & DisallowBaseDependencyParameters<ImplicitParameters<PsBase>> & DisallowBaseParameters<PsBase> & DisallowRuntimeParameters<Ps>

handle ​

RouteHandler<ArgsOf<Ps & PsBase>, R>

Returns ​

Route<PsBase, Ps, R>

Properties ​

method ​

method: HTTPMethod

Defined in: src/routing.ts:94

path ​

path: string

Defined in: src/routing.ts:95

name? ​

optional name: string

Defined in: src/routing.ts:96

tags ​

tags: string[]

Defined in: src/routing.ts:97

summary ​

summary: string

Defined in: src/routing.ts:98

description ​

description: string

Defined in: src/routing.ts:99

deprecated ​

deprecated: boolean

Defined in: src/routing.ts:100

responses ​

responses: Record<number, ResponseConfig>

Defined in: src/routing.ts:101

security? ​

optional security: SecurityRequirementObject[]

Defined in: src/routing.ts:102

statusCode ​

statusCode: number

Defined in: src/routing.ts:103

includeInSchema ​

includeInSchema: boolean

Defined in: src/routing.ts:104

responseClass ​

responseClass: ResponseClass

Defined in: src/routing.ts:105

middleware ​

middleware: Middleware[]

Defined in: src/routing.ts:106

parameters ​

parameters: Ps

Defined in: src/routing.ts:107

handle ​

handle: RouteHandler<Simplify<RuntimeArgs & object & { [K in string | number | symbol]: TypeOf<UnionToIntersection<{ [K in string | number | symbol]: (...)[(...)] extends DependsParameter<(...), (...)> ? (...) & (...) : { [P in (...)]: (...) } }[keyof Ps | keyof PsBase]>[K]> }>, R>

Defined in: src/routing.ts:108

Methods ​

openapi() ​

openapi(): RouteConfig

Defined in: src/routing.ts:148

Returns ​

RouteConfig