Workery

Appearance

Workery

Workery / routing / Router

Class: Router<E> ​

Defined in: src/routing.ts:339

Extended by ​

Type Parameters ​

E ​

E = unknown

Constructors ​

Constructor ​

new Router<E>(init): Router<E>

Defined in: src/routing.ts:349

Parameters ​

init ​
tags? ​

string[]

deprecated? ​

boolean

includeInSchema? ​

boolean

responses? ​

Record<number, ResponseConfig>

security? ​

SecurityRequirementObject[]

defaultResponseClass? ​

ResponseClass

middleware? ​

Middleware<E>[]

Returns ​

Router<E>

Properties ​

tags ​

tags: string[]

Defined in: src/routing.ts:340

deprecated ​

deprecated: boolean

Defined in: src/routing.ts:341

includeInSchema ​

includeInSchema: boolean

Defined in: src/routing.ts:342

responses ​

responses: Record<number, ResponseConfig>

Defined in: src/routing.ts:343

security? ​

optional security: SecurityRequirementObject[]

Defined in: src/routing.ts:344

defaultResponseClass ​

defaultResponseClass: ResponseClass

Defined in: src/routing.ts:345

middleware ​

middleware: Middleware<E>[]

Defined in: src/routing.ts:346

routeMatcher ​

routeMatcher: RouteMatcher<E>

Defined in: src/routing.ts:347

Methods ​

get() ​

get<R, Ps>(path, unboundRoute): Route<R, Ps, E>

Defined in: src/routing.ts:381

Type Parameters ​

R ​

R

Ps ​

Ps extends RouteParameters

Parameters ​

path ​

string

unboundRoute ​

UnboundRoute<R, Ps, E>

Returns ​

Route<R, Ps, E>

post() ​

post<R, Ps>(path, unboundRoute): Route<R, Ps, E>

Defined in: src/routing.ts:387

Type Parameters ​

R ​

R

Ps ​

Ps extends RouteParameters

Parameters ​

path ​

string

unboundRoute ​

UnboundRoute<R, Ps, E>

Returns ​

Route<R, Ps, E>

put() ​

put<R, Ps>(path, unboundRoute): Route<R, Ps, E>

Defined in: src/routing.ts:393

Type Parameters ​

R ​

R

Ps ​

Ps extends RouteParameters

Parameters ​

path ​

string

unboundRoute ​

UnboundRoute<R, Ps, E>

Returns ​

Route<R, Ps, E>

delete() ​

delete<R, Ps>(path, unboundRoute): Route<R, Ps, E>

Defined in: src/routing.ts:399

Type Parameters ​

R ​

R

Ps ​

Ps extends RouteParameters

Parameters ​

path ​

string

unboundRoute ​

UnboundRoute<R, Ps, E>

Returns ​

Route<R, Ps, E>

patch() ​

patch<R, Ps>(path, unboundRoute): Route<R, Ps, E>

Defined in: src/routing.ts:405

Type Parameters ​

R ​

R

Ps ​

Ps extends RouteParameters

Parameters ​

path ​

string

unboundRoute ​

UnboundRoute<R, Ps, E>

Returns ​

Route<R, Ps, E>

head<R, Ps>(path, unboundRoute): Route<R, Ps, E>

Defined in: src/routing.ts:411

Type Parameters ​

R ​

R

Ps ​

Ps extends RouteParameters

Parameters ​

path ​

string

unboundRoute ​

UnboundRoute<R, Ps, E>

Returns ​

Route<R, Ps, E>

trace() ​

trace<R, Ps>(path, unboundRoute): Route<R, Ps, E>

Defined in: src/routing.ts:417

Type Parameters ​

R ​

R

Ps ​

Ps extends RouteParameters

Parameters ​

path ​

string

unboundRoute ​

UnboundRoute<R, Ps, E>

Returns ​

Route<R, Ps, E>

options() ​

options<R, Ps>(path, unboundRoute): Route<R, Ps, E>

Defined in: src/routing.ts:423

Type Parameters ​

R ​

R

Ps ​

Ps extends RouteParameters

Parameters ​

path ​

string

unboundRoute ​

UnboundRoute<R, Ps, E>

Returns ​

Route<R, Ps, E>

route() ​

route<R, Ps>(method, path, unboundRoute): Route<R, Ps, E>

Defined in: src/routing.ts:430

Type Parameters ​

R ​

R

Ps ​

Ps extends RouteParameters

Parameters ​

method ​

HTTPMethod

path ​

string

unboundRoute ​

UnboundRoute<R, Ps, E>

Returns ​

Route<R, Ps, E>