### Hierarchy

- IRouter
  - RouterConstructor

### Callable

- __call(options?: RouterOptions): Router

- - Defined in home/runner/work/opine/opine/src/types.ts:253

  #### Parameters

  - ##### Optional options: RouterOptions

  #### Returns Router

## Index

### Constructors

- constructor

### Properties

- _params
- all
- caseSensitive
- checkout
- connect
- copy
- delete
- get
- head
- lock
- m-search
- merge
- mergeParams
- mkactivity
- mkcol
- move
- notify
- options
- params
- patch
- post
- propfind
- proppatch
- purge
- put
- report
- search
- stack
- strict
- subscribe
- trace
- unlock
- unsubscribe
- use

### Methods

- handle
- param
- process_params
- route

## Constructors

### constructor

- new RouterConstructor(options?: RouterOptions): Router

- - Defined in home/runner/work/opine/opine/src/types.ts:252

  #### Parameters

  - ##### Optional options: RouterOptions

  #### Returns Router

## Properties

### _params

_params: any[]

Inherited from IRouter._params

- Defined in home/runner/work/opine/opine/src/types.ts:200

### all

all: IRouterMatcher<this, "all">

Inherited from IRouter.all

- Defined in home/runner/work/opine/opine/src/types.ts:144

Special-cased "all" method, applying the given route `path`, middleware, and callback to every HTTP method.

### caseSensitive

caseSensitive: boolean

Inherited from IRouter.caseSensitive

- Defined in home/runner/work/opine/opine/src/types.ts:202

### checkout

checkout: IRouterMatcher<this>

Inherited from IRouter.checkout

- Defined in home/runner/work/opine/opine/src/types.ts:153

### connect

connect: IRouterMatcher<this>

Inherited from IRouter.connect

- Defined in home/runner/work/opine/opine/src/types.ts:154

### copy

copy: IRouterMatcher<this>

Inherited from IRouter.copy

- Defined in home/runner/work/opine/opine/src/types.ts:155

### delete

delete: IRouterMatcher<this, "delete">

Inherited from IRouter.delete

- Defined in home/runner/work/opine/opine/src/types.ts:148

### get

get: IRouterMatcher<this, "get">

Inherited from IRouter.get

- Defined in home/runner/work/opine/opine/src/types.ts:145

### head

head: IRouterMatcher<this, "head">

Inherited from IRouter.head

- Defined in home/runner/work/opine/opine/src/types.ts:151

### lock

lock: IRouterMatcher<this>

Inherited from IRouter.lock

- Defined in home/runner/work/opine/opine/src/types.ts:156

### m-search

m-search: IRouterMatcher<this>

Inherited from IRouter.m-search

- Defined in home/runner/work/opine/opine/src/types.ts:161

### merge

merge: IRouterMatcher<this>

Inherited from IRouter.merge

- Defined in home/runner/work/opine/opine/src/types.ts:157

### mergeParams

mergeParams: boolean

Inherited from IRouter.mergeParams

- Defined in home/runner/work/opine/opine/src/types.ts:203

### mkactivity

mkactivity: IRouterMatcher<this>

Inherited from IRouter.mkactivity

- Defined in home/runner/work/opine/opine/src/types.ts:158

### mkcol

mkcol: IRouterMatcher<this>

Inherited from IRouter.mkcol

- Defined in home/runner/work/opine/opine/src/types.ts:159

### move

move: IRouterMatcher<this>

Inherited from IRouter.move

- Defined in home/runner/work/opine/opine/src/types.ts:160

### notify

notify: IRouterMatcher<this>

Inherited from IRouter.notify

- Defined in home/runner/work/opine/opine/src/types.ts:162

### options

options: IRouterMatcher<this, "options">

Inherited from IRouter.options

- Defined in home/runner/work/opine/opine/src/types.ts:150

### params

params: any

Inherited from IRouter.params

- Defined in home/runner/work/opine/opine/src/types.ts:199

### patch

patch: IRouterMatcher<this, "patch">

Inherited from IRouter.patch

- Defined in home/runner/work/opine/opine/src/types.ts:149

### post

post: IRouterMatcher<this, "post">

Inherited from IRouter.post

- Defined in home/runner/work/opine/opine/src/types.ts:146

### propfind

propfind: IRouterMatcher<this>

Inherited from IRouter.propfind

- Defined in home/runner/work/opine/opine/src/types.ts:163

### proppatch

proppatch: IRouterMatcher<this>

Inherited from IRouter.proppatch

- Defined in home/runner/work/opine/opine/src/types.ts:164

### purge

purge: IRouterMatcher<this>

Inherited from IRouter.purge

- Defined in home/runner/work/opine/opine/src/types.ts:165

### put

put: IRouterMatcher<this, "put">

Inherited from IRouter.put

- Defined in home/runner/work/opine/opine/src/types.ts:147

### report

report: IRouterMatcher<this>

Inherited from IRouter.report

- Defined in home/runner/work/opine/opine/src/types.ts:166

### search

search: IRouterMatcher<this>

Inherited from IRouter.search

- Defined in home/runner/work/opine/opine/src/types.ts:167

### stack

stack: any[]

Inherited from IRouter.stack

- Defined in home/runner/work/opine/opine/src/types.ts:209

Stack of configured routes

### strict

strict: boolean

Inherited from IRouter.strict

- Defined in home/runner/work/opine/opine/src/types.ts:204

### subscribe

subscribe: IRouterMatcher<this>

Inherited from IRouter.subscribe

- Defined in home/runner/work/opine/opine/src/types.ts:168

### trace

trace: IRouterMatcher<this>

Inherited from IRouter.trace

- Defined in home/runner/work/opine/opine/src/types.ts:169

### unlock

unlock: IRouterMatcher<this>

Inherited from IRouter.unlock

- Defined in home/runner/work/opine/opine/src/types.ts:170

### unsubscribe

unsubscribe: IRouterMatcher<this>

Inherited from IRouter.unsubscribe

- Defined in home/runner/work/opine/opine/src/types.ts:171

### use

use: IRouterHandler<this> & IRouterMatcher<this>

Inherited from IRouter.use

- Defined in home/runner/work/opine/opine/src/types.ts:173

## Methods

### Private handle

- handle(req: OpineRequest, res: OpineResponse, next?: NextFunction): void

- Inherited from IRouter.handle

  - Defined in home/runner/work/opine/opine/src/types.ts:185

  Dispatch a req, res pair into the application. Starts pipeline processing.

  If no callback is provided, then default error handlers will respond in the event of an error bubbling through the stack.

  #### Parameters

  - ##### req: OpineRequest

  - ##### res: OpineResponse

  - ##### Optional next: NextFunction

  #### Returns void

### param

- param(name: string, fn: RequestParamHandler): void

- Inherited from IRouter.param

  - Defined in home/runner/work/opine/opine/src/types.ts:186

  #### Parameters

  - ##### name: string

  - ##### fn: RequestParamHandler

  #### Returns void

### Private process_params

- process_params(layer: any, called: any, req: OpineRequest, res: OpineResponse, done: NextFunction): void

- Inherited from IRouter.process_params

  - Defined in home/runner/work/opine/opine/src/types.ts:191

  #### Parameters

  - ##### layer: any

  - ##### called: any

  - ##### req: OpineRequest

  - ##### res: OpineResponse

  - ##### done: NextFunction

  #### Returns void

### route

- route(prefix: PathParams): IRoute

- Inherited from IRouter.route

  - Defined in home/runner/work/opine/opine/src/types.ts:175

  #### Parameters

  - ##### prefix: PathParams

  #### Returns IRoute

Generated using TypeDoc