## Index

### Namespaces

- __global

### Interfaces

- Application
- ByteRange
- Cookie
- Dictionary
- Handler
- IRoute
- IRouter
- IRouterHandler
- IRouterMatcher
- MediaType
- NextFunction
- Opine
- OpineRequest
- OpineResponse
- ParamsDictionary
- RangeParserOptions
- RangeParserRange
- RangeParserRanges
- RequestHandler
- RequestRanges
- Router
- RouterConstructor
- RouterOptions

### Type aliases

- ApplicationRequestHandler
- CookieOptions
- CookieWithOptionalValue
- DenoResponseBody
- Errback
- ErrorRequestHandler
- HTTPOptions
- HTTPSOptions
- Params
- ParamsArray
- ParsedURL
- PathParams
- RangeParserResult
- RangeParserResultInvalid
- RangeParserResultUnsatisfiable
- RequestHandlerParams
- RequestParamHandler
- ResponseBody
- Send

## Type aliases

### ApplicationRequestHandler

ApplicationRequestHandler<T>: IRouterHandler<T> & IRouterMatcher<T> & (...handlers: RequestHandlerParams[]) => T

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

#### Type parameters

- #### T

### CookieOptions

CookieOptions: Omit<Cookie, "name" | "value">

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

### CookieWithOptionalValue

CookieWithOptionalValue: Omit<Cookie, "value"> & { value?: Cookie["value"] }

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

### DenoResponseBody

DenoResponseBody: undefined | string | Uint8Array | Deno.Reader | ReadableStream

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

### Errback

Errback: (err: Error) => void

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

#### Type declaration

- - (err: Error): void

  - #### Parameters

    - ##### err: Error

    #### Returns void

### ErrorRequestHandler

ErrorRequestHandler<P, ResBody, ReqQuery>: (err: any, req: OpineRequest<P, ResBody, ReqQuery>, res: OpineResponse<ResBody>, next: NextFunction) => any

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

#### Type parameters

- #### P: Params = ParamsDictionary

- #### ResBody = any

- #### ReqQuery = any

#### Type declaration

- - (err: any, req: OpineRequest<P, ResBody, ReqQuery>, res: OpineResponse<ResBody>, next: NextFunction): any

  - #### Parameters

    - ##### err: any

    - ##### req: OpineRequest<P, ResBody, ReqQuery>

    - ##### res: OpineResponse<ResBody>

    - ##### next: NextFunction

    #### Returns any

### HTTPOptions

HTTPOptions: Omit<Deno.ListenOptions, "transport">

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

### HTTPSOptions

HTTPSOptions: Omit<Deno.ListenTlsOptions & { certFile: string; keyFile: string }, "transport">

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

### Params

Params: ParamsDictionary | ParamsArray

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

### ParamsArray

ParamsArray: string[]

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

### ParsedURL

ParsedURL: URL & { _raw?: string | null; path?: string | null; query?: string | null }

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

### PathParams

PathParams: string | RegExp | Array<string | RegExp>

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

### RangeParserResult

RangeParserResult: RangeParserResultUnsatisfiable | RangeParserResultInvalid

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

### RangeParserResultInvalid

RangeParserResultInvalid: -2

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

### RangeParserResultUnsatisfiable

RangeParserResultUnsatisfiable: -1

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

### RequestHandlerParams

RequestHandlerParams<P, ResBody, ReqQuery>: RequestHandler<P, ResBody, ReqQuery> | ErrorRequestHandler<P, ResBody, ReqQuery> | Array<RequestHandler<P> | ErrorRequestHandler<P>>

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

#### Type parameters

- #### P: Params = ParamsDictionary

- #### ResBody = any

- #### ReqQuery = any

### RequestParamHandler

RequestParamHandler: (req: OpineRequest, res: OpineResponse, next: NextFunction, value: any, name: string) => any

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

#### Type declaration

- - (req: OpineRequest, res: OpineResponse, next: NextFunction, value: any, name: string): any

  - #### Parameters

    - ##### req: OpineRequest

    - ##### res: OpineResponse

    - ##### next: NextFunction

    - ##### value: any

    - ##### name: string

    #### Returns any

### ResponseBody

ResponseBody: null | undefined | number | boolean | Record<string, unknown> | DenoResponseBody

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

### Send

Send<ResBody, T>: (body?: ResBody) => T

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

#### Type parameters

- #### ResBody = any

- #### T = OpineResponse<ResBody>

#### Type declaration

- - (body?: ResBody): T

  - #### Parameters

    - ##### Optional body: ResBody

    #### Returns T

Generated using TypeDoc