Cerces

Appearance

Cerces

Cerces / core / App

Class: App<PsThis> ​

Defined in: src/core.ts:236

Extends ​

Type Parameters ​

PsThis ​

PsThis extends GenericRouteParameters<PsThis> = { }

Constructors ​

Constructor ​

new App<PsThis>(init): App<PsThis>

Defined in: src/core.ts:254

Parameters ​

init ​

`/${string}` extends PathStringOf<PsThis> ? object : object & object

Returns ​

App<PsThis>

Overrides ​

Router.constructor

Properties ​

tags ​

tags: string[]

Defined in: src/core.ts:90

Inherited from ​

Router.tags

deprecated ​

deprecated: boolean

Defined in: src/core.ts:91

Inherited from ​

Router.deprecated

includeInSchema ​

includeInSchema: boolean

Defined in: src/core.ts:92

Inherited from ​

Router.includeInSchema

responses ​

responses: Record<number, ResponseConfig>

Defined in: src/core.ts:93

Inherited from ​

Router.responses

defaultResponseClass ​

defaultResponseClass: ResponseClass

Defined in: src/core.ts:95

Inherited from ​

Router.defaultResponseClass

parameters ​

parameters: PsThis

Defined in: src/core.ts:96

Inherited from ​

Router.parameters

middleware ​

middleware: Middleware[]

Defined in: src/core.ts:97

Inherited from ​

Router.middleware

routeMatcher ​

routeMatcher: RouteMatcher

Defined in: src/core.ts:98

Inherited from ​

Router.routeMatcher

rootPath ​

rootPath: string

Defined in: src/core.ts:237

Overrides ​

Router.rootPath

title ​

title: string

Defined in: src/core.ts:238

description ​

description: string

Defined in: src/core.ts:239

version ​

version: string

Defined in: src/core.ts:240

tagsInfo ​

tagsInfo: TagObject[]

Defined in: src/core.ts:241

servers ​

servers: ServerObject[]

Defined in: src/core.ts:242

contact? ​

optional contact: ContactObject

Defined in: src/core.ts:243

license? ​

optional license: LicenseObject

Defined in: src/core.ts:244

termsOfService? ​

optional termsOfService: string

Defined in: src/core.ts:245

securitySchemes ​

securitySchemes: Record<string, SecuritySchemeObject>

Defined in: src/core.ts:246

security ​

security: SecurityRequirementObject[]

Defined in: src/core.ts:247

Overrides ​

Router.security

openapiUrl ​

openapiUrl: null | `/${string}`

Defined in: src/core.ts:248

swaggerUrl ​

swaggerUrl: null | `/${string}`

Defined in: src/core.ts:249

redocUrl ​

redocUrl: null | `/${string}`

Defined in: src/core.ts:250

errorHandler ​

errorHandler: ErrorHandler

Defined in: src/core.ts:251

Methods ​

get() ​

get<Ps, R>(path, unboundRoute): Route<PsThis & object, Ps, R>

Defined in: src/core.ts:140

Type Parameters ​

Ps ​

Ps extends RouteParameters = { }

R ​

R = unknown

Parameters ​

path ​

PathString<keyof { [K in string | number | symbol as Omit<UnionToIntersection<{ [K in string | number | symbol]: (...)[(...)] extends DependsParameter<(...), (...)> ? (...) & (...) : { [P in (...)]: (...) } }[keyof Ps]>, keyof UnionToIntersection<{ [K in (...) | (...) | (...)]: (...) extends (...) ? (...) : (...) }[keyof PsThis]>>[K] extends PathParameter<Schema> ? Schema extends ZodOptional<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>> ? never : K : never]: Omit<UnionToIntersection<{ [K in string | number | symbol]: Ps[K] extends DependsParameter<any, PsDepend> ? UnionToIntersection<(...)> & { [P in (...)]: (...) } : { [P in (...) | (...) | (...)]: (...)[(...)] } }[keyof Ps]>, keyof UnionToIntersection<{ [K in string | number | symbol]: (...)[(...)] extends DependsParameter<(...), (...)> ? (...) & (...) : { [P in (...)]: (...) } }[keyof PsThis]>>[K] }>

unboundRoute ​

UnboundRoute<PsThis & object, Ps, R>

Returns ​

Route<PsThis & object, Ps, R>

Inherited from ​

Router.get

post() ​

post<Ps, R>(path, unboundRoute): Route<PsThis & object, Ps, R>

Defined in: src/core.ts:146

Type Parameters ​

Ps ​

Ps extends RouteParameters = { }

R ​

R = unknown

Parameters ​

path ​

PathString<keyof { [K in string | number | symbol as Omit<UnionToIntersection<{ [K in string | number | symbol]: (...)[(...)] extends DependsParameter<(...), (...)> ? (...) & (...) : { [P in (...)]: (...) } }[keyof Ps]>, keyof UnionToIntersection<{ [K in (...) | (...) | (...)]: (...) extends (...) ? (...) : (...) }[keyof PsThis]>>[K] extends PathParameter<Schema> ? Schema extends ZodOptional<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>> ? never : K : never]: Omit<UnionToIntersection<{ [K in string | number | symbol]: Ps[K] extends DependsParameter<any, PsDepend> ? UnionToIntersection<(...)> & { [P in (...)]: (...) } : { [P in (...) | (...) | (...)]: (...)[(...)] } }[keyof Ps]>, keyof UnionToIntersection<{ [K in string | number | symbol]: (...)[(...)] extends DependsParameter<(...), (...)> ? (...) & (...) : { [P in (...)]: (...) } }[keyof PsThis]>>[K] }>

unboundRoute ​

UnboundRoute<PsThis & object, Ps, R>

Returns ​

Route<PsThis & object, Ps, R>

Inherited from ​

Router.post

put() ​

put<Ps, R>(path, unboundRoute): Route<PsThis & object, Ps, R>

Defined in: src/core.ts:152

Type Parameters ​

Ps ​

Ps extends RouteParameters = { }

R ​

R = unknown

Parameters ​

path ​

PathString<keyof { [K in string | number | symbol as Omit<UnionToIntersection<{ [K in string | number | symbol]: (...)[(...)] extends DependsParameter<(...), (...)> ? (...) & (...) : { [P in (...)]: (...) } }[keyof Ps]>, keyof UnionToIntersection<{ [K in (...) | (...) | (...)]: (...) extends (...) ? (...) : (...) }[keyof PsThis]>>[K] extends PathParameter<Schema> ? Schema extends ZodOptional<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>> ? never : K : never]: Omit<UnionToIntersection<{ [K in string | number | symbol]: Ps[K] extends DependsParameter<any, PsDepend> ? UnionToIntersection<(...)> & { [P in (...)]: (...) } : { [P in (...) | (...) | (...)]: (...)[(...)] } }[keyof Ps]>, keyof UnionToIntersection<{ [K in string | number | symbol]: (...)[(...)] extends DependsParameter<(...), (...)> ? (...) & (...) : { [P in (...)]: (...) } }[keyof PsThis]>>[K] }>

unboundRoute ​

UnboundRoute<PsThis & object, Ps, R>

Returns ​

Route<PsThis & object, Ps, R>

Inherited from ​

Router.put

delete() ​

delete<Ps, R>(path, unboundRoute): Route<PsThis & object, Ps, R>

Defined in: src/core.ts:158

Type Parameters ​

Ps ​

Ps extends RouteParameters = { }

R ​

R = unknown

Parameters ​

path ​

PathString<keyof { [K in string | number | symbol as Omit<UnionToIntersection<{ [K in string | number | symbol]: (...)[(...)] extends DependsParameter<(...), (...)> ? (...) & (...) : { [P in (...)]: (...) } }[keyof Ps]>, keyof UnionToIntersection<{ [K in (...) | (...) | (...)]: (...) extends (...) ? (...) : (...) }[keyof PsThis]>>[K] extends PathParameter<Schema> ? Schema extends ZodOptional<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>> ? never : K : never]: Omit<UnionToIntersection<{ [K in string | number | symbol]: Ps[K] extends DependsParameter<any, PsDepend> ? UnionToIntersection<(...)> & { [P in (...)]: (...) } : { [P in (...) | (...) | (...)]: (...)[(...)] } }[keyof Ps]>, keyof UnionToIntersection<{ [K in string | number | symbol]: (...)[(...)] extends DependsParameter<(...), (...)> ? (...) & (...) : { [P in (...)]: (...) } }[keyof PsThis]>>[K] }>

unboundRoute ​

UnboundRoute<PsThis & object, Ps, R>

Returns ​

Route<PsThis & object, Ps, R>

Inherited from ​

Router.delete

patch() ​

patch<Ps, R>(path, unboundRoute): Route<PsThis & object, Ps, R>

Defined in: src/core.ts:164

Type Parameters ​

Ps ​

Ps extends RouteParameters = { }

R ​

R = unknown

Parameters ​

path ​

PathString<keyof { [K in string | number | symbol as Omit<UnionToIntersection<{ [K in string | number | symbol]: (...)[(...)] extends DependsParameter<(...), (...)> ? (...) & (...) : { [P in (...)]: (...) } }[keyof Ps]>, keyof UnionToIntersection<{ [K in (...) | (...) | (...)]: (...) extends (...) ? (...) : (...) }[keyof PsThis]>>[K] extends PathParameter<Schema> ? Schema extends ZodOptional<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>> ? never : K : never]: Omit<UnionToIntersection<{ [K in string | number | symbol]: Ps[K] extends DependsParameter<any, PsDepend> ? UnionToIntersection<(...)> & { [P in (...)]: (...) } : { [P in (...) | (...) | (...)]: (...)[(...)] } }[keyof Ps]>, keyof UnionToIntersection<{ [K in string | number | symbol]: (...)[(...)] extends DependsParameter<(...), (...)> ? (...) & (...) : { [P in (...)]: (...) } }[keyof PsThis]>>[K] }>

unboundRoute ​

UnboundRoute<PsThis & object, Ps, R>

Returns ​

Route<PsThis & object, Ps, R>

Inherited from ​

Router.patch

head<Ps, R>(path, unboundRoute): Route<PsThis & object, Ps, R>

Defined in: src/core.ts:170

Type Parameters ​

Ps ​

Ps extends RouteParameters = { }

R ​

R = unknown

Parameters ​

path ​

PathString<keyof { [K in string | number | symbol as Omit<UnionToIntersection<{ [K in string | number | symbol]: (...)[(...)] extends DependsParameter<(...), (...)> ? (...) & (...) : { [P in (...)]: (...) } }[keyof Ps]>, keyof UnionToIntersection<{ [K in (...) | (...) | (...)]: (...) extends (...) ? (...) : (...) }[keyof PsThis]>>[K] extends PathParameter<Schema> ? Schema extends ZodOptional<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>> ? never : K : never]: Omit<UnionToIntersection<{ [K in string | number | symbol]: Ps[K] extends DependsParameter<any, PsDepend> ? UnionToIntersection<(...)> & { [P in (...)]: (...) } : { [P in (...) | (...) | (...)]: (...)[(...)] } }[keyof Ps]>, keyof UnionToIntersection<{ [K in string | number | symbol]: (...)[(...)] extends DependsParameter<(...), (...)> ? (...) & (...) : { [P in (...)]: (...) } }[keyof PsThis]>>[K] }>

unboundRoute ​

UnboundRoute<PsThis & object, Ps, R>

Returns ​

Route<PsThis & object, Ps, R>

Inherited from ​

Router.head

trace() ​

trace<Ps, R>(path, unboundRoute): Route<PsThis & object, Ps, R>

Defined in: src/core.ts:176

Type Parameters ​

Ps ​

Ps extends RouteParameters = { }

R ​

R = unknown

Parameters ​

path ​

PathString<keyof { [K in string | number | symbol as Omit<UnionToIntersection<{ [K in string | number | symbol]: (...)[(...)] extends DependsParameter<(...), (...)> ? (...) & (...) : { [P in (...)]: (...) } }[keyof Ps]>, keyof UnionToIntersection<{ [K in (...) | (...) | (...)]: (...) extends (...) ? (...) : (...) }[keyof PsThis]>>[K] extends PathParameter<Schema> ? Schema extends ZodOptional<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>> ? never : K : never]: Omit<UnionToIntersection<{ [K in string | number | symbol]: Ps[K] extends DependsParameter<any, PsDepend> ? UnionToIntersection<(...)> & { [P in (...)]: (...) } : { [P in (...) | (...) | (...)]: (...)[(...)] } }[keyof Ps]>, keyof UnionToIntersection<{ [K in string | number | symbol]: (...)[(...)] extends DependsParameter<(...), (...)> ? (...) & (...) : { [P in (...)]: (...) } }[keyof PsThis]>>[K] }>

unboundRoute ​

UnboundRoute<PsThis & object, Ps, R>

Returns ​

Route<PsThis & object, Ps, R>

Inherited from ​

Router.trace

options() ​

options<Ps, R>(path, unboundRoute): Route<PsThis & object, Ps, R>

Defined in: src/core.ts:182

Type Parameters ​

Ps ​

Ps extends RouteParameters = { }

R ​

R = unknown

Parameters ​

path ​

PathString<keyof { [K in string | number | symbol as Omit<UnionToIntersection<{ [K in string | number | symbol]: (...)[(...)] extends DependsParameter<(...), (...)> ? (...) & (...) : { [P in (...)]: (...) } }[keyof Ps]>, keyof UnionToIntersection<{ [K in (...) | (...) | (...)]: (...) extends (...) ? (...) : (...) }[keyof PsThis]>>[K] extends PathParameter<Schema> ? Schema extends ZodOptional<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>> ? never : K : never]: Omit<UnionToIntersection<{ [K in string | number | symbol]: Ps[K] extends DependsParameter<any, PsDepend> ? UnionToIntersection<(...)> & { [P in (...)]: (...) } : { [P in (...) | (...) | (...)]: (...)[(...)] } }[keyof Ps]>, keyof UnionToIntersection<{ [K in string | number | symbol]: (...)[(...)] extends DependsParameter<(...), (...)> ? (...) & (...) : { [P in (...)]: (...) } }[keyof PsThis]>>[K] }>

unboundRoute ​

UnboundRoute<PsThis & object, Ps, R>

Returns ​

Route<PsThis & object, Ps, R>

Inherited from ​

Router.options

route() ​

route<Ps, R>(method, path, unboundRoute): Route<PsThis & object, Ps, R>

Defined in: src/core.ts:189

Type Parameters ​

Ps ​

Ps extends RouteParameters = { }

R ​

R = unknown

Parameters ​

method ​

HTTPMethod

path ​

PathString<keyof { [K in string | number | symbol as Omit<UnionToIntersection<{ [K in string | number | symbol]: (...)[(...)] extends DependsParameter<(...), (...)> ? (...) & (...) : { [P in (...)]: (...) } }[keyof Ps]>, keyof UnionToIntersection<{ [K in (...) | (...) | (...)]: (...) extends (...) ? (...) : (...) }[keyof PsThis]>>[K] extends PathParameter<Schema> ? Schema extends ZodOptional<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>> ? never : K : never]: Omit<UnionToIntersection<{ [K in string | number | symbol]: Ps[K] extends DependsParameter<any, PsDepend> ? UnionToIntersection<(...)> & { [P in (...)]: (...) } : { [P in (...) | (...) | (...)]: (...)[(...)] } }[keyof Ps]>, keyof UnionToIntersection<{ [K in string | number | symbol]: (...)[(...)] extends DependsParameter<(...), (...)> ? (...) & (...) : { [P in (...)]: (...) } }[keyof PsThis]>>[K] }>

unboundRoute ​

UnboundRoute<PsThis & object, Ps, R>

Returns ​

Route<PsThis & object, Ps, R>

Inherited from ​

Router.route

include() ​

include<Ps>(prefix, router): void

Defined in: src/core.ts:216

Type Parameters ​

Ps ​

Ps extends RouteParameters

Parameters ​

prefix ​

PathString<keyof { [K in string | number | symbol as Omit<UnionToIntersection<{ [K in string | number | symbol]: (...)[(...)] extends DependsParameter<(...), (...)> ? (...) & (...) : { [P in (...)]: (...) } }[keyof Ps]>, keyof UnionToIntersection<{ [K in (...) | (...) | (...)]: (...) extends (...) ? (...) : (...) }[keyof PsThis]>>[K] extends PathParameter<Schema> ? Schema extends ZodOptional<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>> ? never : K : never]: Omit<UnionToIntersection<{ [K in string | number | symbol]: Ps[K] extends DependsParameter<any, PsDepend> ? UnionToIntersection<(...)> & { [P in (...)]: (...) } : { [P in (...) | (...) | (...)]: (...)[(...)] } }[keyof Ps]>, keyof UnionToIntersection<{ [K in string | number | symbol]: (...)[(...)] extends DependsParameter<(...), (...)> ? (...) & (...) : { [P in (...)]: (...) } }[keyof PsThis]>>[K] }>

router ​

Router<PsThis & object, Ps>

Returns ​

void

Inherited from ​

Router.include

openapi() ​

openapi(): OpenAPIObject

Defined in: src/core.ts:337

Returns ​

OpenAPIObject

handle() ​

handle(baseArgs): Promise<Response>

Defined in: src/core.ts:365

Parameters ​

baseArgs ​
req ​

Request

Returns ​

Promise<Response>

fetch() ​

fetch(req, ...args): Promise<Response>

Defined in: src/core.ts:427

Parameters ​

req ​

Request

args ​

...any[]

Returns ​

Promise<Response>