ShokupanRoute
ShokupanRoute =
object
Defined in: src/types.ts:116
Properties
Section titled “Properties”bakedHandler?
Section titled “bakedHandler?”
optionalbakedHandler:ShokupanHandler
Defined in: src/types.ts:141
Optimization: Handler with hooks baked in.
Used by runtime router, while handler is used by OpenAPI generator.
controller?
Section titled “controller?”
optionalcontroller:any
Defined in: src/types.ts:186
Controller instance this route belongs to
group?
Section titled “group?”
optionalgroup:string
Defined in: src/types.ts:149
Group for the route
guards?
Section titled “guards?”
optionalguards:object[]
Defined in: src/types.ts:153
Guards for the route
handler
Section titled “handler”handler:
ShokupanHandler
Guard handler
optionalspec:GuardAPISpec
Guard OpenAPI spec
handler
Section titled “handler”handler:
ShokupanHandler
Defined in: src/types.ts:136
Route handler
handlerSpec?
Section titled “handlerSpec?”
optionalhandlerSpec:MethodAPISpec
Defined in: src/types.ts:145
OpenAPI spec for the route
hooks?
Section titled “hooks?”
optionalhooks:ShokupanHooks
Defined in: src/types.ts:174
Hooks from the router/route definition
keys:
string[]
Defined in: src/types.ts:132
Route parameters
metadata?
Section titled “metadata?”
optionalmetadata:RouteMetadata
Defined in: src/types.ts:178
Source metadata
method
Section titled “method”method:
Method
Defined in: src/types.ts:120
HTTP method
order?
Section titled “order?”
optionalorder:number
Defined in: src/types.ts:182
Order of the middleware
path:
string
Defined in: src/types.ts:124
Route path
regex:
RegExp
Defined in: src/types.ts:128
Compiled regex for the route
renderer?
Section titled “renderer?”
optionalrenderer:JSXRenderer
Defined in: src/types.ts:170
Custom JSX renderer for this route.
requestTimeout?
Section titled “requestTimeout?”
optionalrequestTimeout:number
Defined in: src/types.ts:166
Timeout for this specific route (milliseconds).