Class Router

Index

Constructors

constructor

Properties

#guarded #middlewares

Accessors

guarded methods middlewares

Methods

delete get head off on options patch post put trace

Constructors

constructor

new Router(__namedParameters?): Router
Parameters
- __namedParameters: IRouterOptions = {}
Returns Router
- Defined in src/router.ts:12

Properties

`Private` #guarded

#guarded: boolean

`Private` `Readonly` #middlewares

#middlewares: Map<string, IMiddleware[]>

Accessors

guarded

get guarded(): boolean
Returns boolean
- Defined in src/router.ts:17
set guarded(guarded): void
Parameters
- guarded: unknown
Returns void
- Defined in src/router.ts:21

methods

get methods(): Set<string>
Get all supported methods by the router

Returns Set<string>
- Defined in src/router.ts:26

middlewares

get middlewares(): ((method) => IMiddleware[])
Returns ((method) => IMiddleware[])
- - (method): IMiddleware[]
  - Parameters
    - method: string
    Returns IMiddleware[]
- Defined in src/router.ts:38

Methods

delete

delete(...middlewares): this
Parameters
- Rest ...middlewares: IMiddleware[]
Returns this
- Defined in src/router.ts:98

get

get(...middlewares): this
Parameters
- Rest ...middlewares: IMiddleware[]
Returns this
- Defined in src/router.ts:102

head

head(...middlewares): this
Parameters
- Rest ...middlewares: IMiddleware[]
Returns this
- Defined in src/router.ts:106

off

off(method, ..._middlewares): IMiddleware[]
Parameters
- method: string
- Rest ..._middlewares: IMiddleware[]
Returns IMiddleware[]
- Defined in src/router.ts:70

on

on(method, ..._middlewares): this
Parameters
- method: string
- Rest ..._middlewares: IMiddleware[]
Returns this
- Defined in src/router.ts:44

options

options(...middlewares): this
Parameters
- Rest ...middlewares: IMiddleware[]
Returns this
- Defined in src/router.ts:110

patch

patch(...middlewares): this
Parameters
- Rest ...middlewares: IMiddleware[]
Returns this
- Defined in src/router.ts:114

post

post(...middlewares): this
Parameters
- Rest ...middlewares: IMiddleware[]
Returns this
- Defined in src/router.ts:118

put

put(...middlewares): this
Parameters
- Rest ...middlewares: IMiddleware[]
Returns this
- Defined in src/router.ts:122

trace

trace(...middlewares): this
Parameters
- Rest ...middlewares: IMiddleware[]
Returns this
- Defined in src/router.ts:126

Settings

Member Visibility

Theme