Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "types"

Index

Type aliases

ApplicationRequestHandler

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

Type parameters

  • T

CookieOptions

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

CookieWithOptionalValue

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

DenoResponseBody

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

Errback

Errback: (err: Error) => void

Type declaration

    • Parameters

      Returns void

ErrorRequestHandler

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

Type parameters

  • P: Params = ParamsDictionary

  • ResBody = any

  • ReqQuery = any

Type declaration

HTTPOptions

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

HTTPSOptions

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

Params

ParamsArray

ParamsArray: string[]

ParsedURL

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

PathParams

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

RangeParserResult

RangeParserResultInvalid

RangeParserResultInvalid: -2

RangeParserResultUnsatisfiable

RangeParserResultUnsatisfiable: -1

RequestHandlerParams

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

Type parameters

  • P: Params = ParamsDictionary

  • ResBody = any

  • ReqQuery = any

RequestParamHandler

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

Type declaration

ResponseBody

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

Send

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

Type parameters

  • ResBody = any

  • T = OpineResponse<ResBody>

Type declaration

    • (body?: ResBody): T
    • Parameters

      • Optional body: ResBody

      Returns T

Generated using TypeDoc