ShokupanRoute

ShokupanRoute = object

Defined in: src/util/types.ts:172

Properties

bakedHandler?

optional bakedHandler: ShokupanHandler

Defined in: src/util/types.ts:197

Optimization: Handler with hooks baked in. Used by runtime router, while handler is used by OpenAPI generator.

---

controller?

optional controller: any

Defined in: src/util/types.ts:242

Controller instance this route belongs to

---

group?

optional group: string

Defined in: src/util/types.ts:205

Group for the route

---

guards?

optional guards: object[]

Defined in: src/util/types.ts:209

Guards for the route

handler

handler: ShokupanHandler

Guard handler

spec?

optional spec: GuardAPISpec

Guard OpenAPI spec

---

handler

handler: ShokupanHandler

Defined in: src/util/types.ts:192

Route handler

---

handlerSpec?

optional handlerSpec: MethodAPISpec

Defined in: src/util/types.ts:201

OpenAPI spec for the route

---

hooks?

optional hooks: ShokupanHooks

Defined in: src/util/types.ts:230

Hooks from the router/route definition

---

keys

keys: string[]

Defined in: src/util/types.ts:188

Route parameters

---

metadata?

optional metadata: RouteMetadata

Defined in: src/util/types.ts:234

Source metadata

---

method

method: Method

Defined in: src/util/types.ts:176

HTTP method

---

order?

optional order: number

Defined in: src/util/types.ts:238

Order of the middleware

---

path

path: string

Defined in: src/util/types.ts:180

Route path

---

regex

regex: RegExp

Defined in: src/util/types.ts:184

Compiled regex for the route

---

renderer?

optional renderer: JSXRenderer

Defined in: src/util/types.ts:226

Custom JSX renderer for this route.

---

requestTimeout?

optional requestTimeout: number

Defined in: src/util/types.ts:222

Timeout for this specific route (milliseconds).