Interface RoutableContext

RoutableContext is additional interface that structures implementing Context must implement. Methods inside this interface are meant for request routing purposes and should not be used in middlewares.

Hierarchy

RoutableContext

Indexable

[key: string]: any

Index

Methods

rawPathParams request set setPath setRawPathParams setRouteInfo

Methods

rawPathParams

rawPathParams(): PathParams
RawPathParams returns raw path pathParams value. Allocation of PathParams is handled by Context.

Returns PathParams
- Defined in types.d.ts:19282

request

request(): Request
Request returns *http.Request.

Returns Request
- Defined in types.d.ts:19278

set

set(key, val): void
Set saves data in the context. Allows router to store arbitrary (that only router has access to) data in context for later use in middlewares/handler.
Parameters
- key: string
- val: {}
Returns void
- Defined in types.d.ts:19300

setPath

setPath(p): void
SetPath sets the registered path for the handler.
Parameters
- p: string
Returns void
- Defined in types.d.ts:19291

setRawPathParams

setRawPathParams(params): void
SetRawPathParams replaces any existing param values with new values for this context lifetime (request). Do not set any other value than what you got from RawPathParams as allocation of PathParams is handled by Context.
Parameters
- params: PathParams
Returns void
- Defined in types.d.ts:19287

setRouteInfo

setRouteInfo(ri): void
SetRouteInfo sets the route info of this request to the context.
Parameters
- ri: RouteInfo
Returns void
- Defined in types.d.ts:19295

Generated using TypeDoc