Workery

---

Workery / routing / Route

Class: Route<R, Ps, E>

Defined in: src/routing.ts:78

Type Parameters

R

R

Ps

Ps extends RouteParameters

E

E = unknown

Constructors

Constructor

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

Defined in: src/routing.ts:95

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<E>[]

parameters

Ps

handle

RouteHandler<R, Ps, E>

Returns

Route<R, Ps, E>

Properties

method

method: HTTPMethod

Defined in: src/routing.ts:79

---

path

path: string

Defined in: src/routing.ts:80

---

name?

optional name: string

Defined in: src/routing.ts:81

---

tags

tags: string[]

Defined in: src/routing.ts:82

---

summary

summary: string

Defined in: src/routing.ts:83

---

description

description: string

Defined in: src/routing.ts:84

---

deprecated

deprecated: boolean

Defined in: src/routing.ts:85

---

responses

responses: Record<number, ResponseConfig>

Defined in: src/routing.ts:86

---

security?

optional security: SecurityRequirementObject[]

Defined in: src/routing.ts:87

---

statusCode

statusCode: number

Defined in: src/routing.ts:88

---

includeInSchema

includeInSchema: boolean

Defined in: src/routing.ts:89

---

responseClass

responseClass: ResponseClass

Defined in: src/routing.ts:90

---

middleware

middleware: Middleware<E>[]

Defined in: src/routing.ts:91

---

parameters

parameters: Ps

Defined in: src/routing.ts:92

---

handle

handle: RouteHandler<R, Ps, E>

Defined in: src/routing.ts:93

Methods

openapi()

openapi(): RouteConfig

Defined in: src/routing.ts:129

Returns

RouteConfig