Class default

Hierarchy

Router
- default

Index

Constructors

constructor

new default(): default
Returns default
Overrides Router.constructor
- Defined in foxify/src/Foxify.ts:125

Properties

`Private` _settings

_settings: Settings = ...

`Private` `Optional` _view

_view?: Engine

acl

acl: ShortHandRouteT<default, Response, default>

bind

bind: ShortHandRouteT<default, Response, default>

`Protected` catchers

catchers: ErrorHandlerT<default, Response>[] = []

checkout

checkout: ShortHandRouteT<default, Response, default>

connect

connect: ShortHandRouteT<default, Response, default>

copy

copy: ShortHandRouteT<default, Response, default>

delete

delete: ShortHandRouteT<default, Response, default>

get

get: ShortHandRouteT<default, Response, default>

head

head: ShortHandRouteT<default, Response, default>

link

link: ShortHandRouteT<default, Response, default>

lock

lock: ShortHandRouteT<default, Response, default>

m-search

m-search: ShortHandRouteT<default, Response, default>

merge

merge: ShortHandRouteT<default, Response, default>

`Protected` middlewares

middlewares: HandlerT<default, Response>[] = []

mkactivity

mkactivity: ShortHandRouteT<default, Response, default>

mkcalendar

mkcalendar: ShortHandRouteT<default, Response, default>

mkcol

mkcol: ShortHandRouteT<default, Response, default>

move

move: ShortHandRouteT<default, Response, default>

notify

notify: ShortHandRouteT<default, Response, default>

options

options: ShortHandRouteT<default, Response, default>

`Protected` `Readonly` paramHandlers

paramHandlers: ParamHandlerI<default, Response> = {}

patch

patch: ShortHandRouteT<default, Response, default>

post

post: ShortHandRouteT<default, Response, default>

`Protected` `Readonly` prefix

prefix: string = "/"

pri

pri: ShortHandRouteT<default, Response, default>

propfind

propfind: ShortHandRouteT<default, Response, default>

proppatch

proppatch: ShortHandRouteT<default, Response, default>

purge

purge: ShortHandRouteT<default, Response, default>

put

put: ShortHandRouteT<default, Response, default>

rebind

rebind: ShortHandRouteT<default, Response, default>

report

report: ShortHandRouteT<default, Response, default>

search

search: ShortHandRouteT<default, Response, default>

source

source: ShortHandRouteT<default, Response, default>

subscribe: ShortHandRouteT<default, Response, default>

trace

trace: ShortHandRouteT<default, Response, default>

`Protected` `Readonly` tree

tree: Node<default, Response> = ...

unbind

unbind: ShortHandRouteT<default, Response, default>

unlink

unlink: ShortHandRouteT<default, Response, default>

unlock

unlock: ShortHandRouteT<default, Response, default>

unsubscribe

unsubscribe: ShortHandRouteT<default, Response, default>

`Static` static

static: any = serveStatic

Methods

all

all(path: string, options?: null | false | OptionsI | HandlerT<default, Response> | HandlersT<default, Response>, ...handlers: HandlersT<default, Response>): default
Parameters
- path: string
- Optional options: null | false | OptionsI | HandlerT<default, Response> | HandlersT<default, Response>
- Rest ...handlers: HandlersT<default, Response>
Returns default
Inherited from Router.all
- Defined in router/src/Router.ts:97

catch

catch(...handlers: ErrorHandlersT<default, Response>): default
Parameters
- Rest ...handlers: ErrorHandlersT<default, Response>
Returns default
Inherited from Router.catch
- Defined in router/src/Router.ts:106

`Protected` defaultCatch

defaultCatch(error: Error, request: default, response: Response): void
Parameters
- error: Error
- request: default
- response: Response
Returns void
Inherited from Router.defaultCatch
- Defined in router/src/Router.ts:444

disable

disable(setting: keyof Settings): default
Parameters
- setting: keyof Settings
Returns default
- Defined in foxify/src/Foxify.ts:139

disabled

disabled(setting: keyof Settings): boolean
Parameters
- setting: keyof Settings
Returns boolean
- Defined in foxify/src/Foxify.ts:143

enable

enable(setting: keyof Settings): default
Parameters
- setting: keyof Settings
Returns default
- Defined in foxify/src/Foxify.ts:147

enabled

enabled(setting: keyof Settings): boolean
Parameters
- setting: keyof Settings
Returns boolean
- Defined in foxify/src/Foxify.ts:151

engine

engine(extension: string, path: string, handler: (() => void)): default
Handle view
Parameters
- extension: string
  
  view template file extension
- path: string
  
  the directory containing view templates
- handler: (() => void)
  - - (): void
    - Returns void
Returns default
- Defined in foxify/src/Foxify.ts:161

find

find(method: MethodT, path: string): HandlersResultT<default, Response>
Parameters
- method: MethodT
- path: string
Returns HandlersResultT<default, Response>
Inherited from Router.find
- Defined in router/src/Router.ts:116

`Protected` generateCatchNext

generateCatchNext(error: Error, req: default, res: Response, catchers?: ErrorHandlerT<default, Response>[]): NextT
Parameters
- error: Error
- req: default
- res: Response
- catchers: ErrorHandlerT<default, Response>[] = []
Returns NextT
Inherited from Router.generateCatchNext
- Defined in router/src/Router.ts:516

`Protected` generateNext

generateNext(req: default, res: Response, method: MethodT, allowHeader: string, handlers?: HandlerT<default, Response>[]): NextT
Parameters
- req: default
- res: Response
- method: MethodT
- allowHeader: string
- handlers: HandlerT<default, Response>[] = []
Returns NextT
Inherited from Router.generateNext
- Defined in router/src/Router.ts:553

inject

inject(options: string | OptionsI<IncomingMessage, ServerResponse<IncomingMessage>>): Promise<InjectResultI<default, Response>>
Parameters
- options: string | OptionsI<IncomingMessage, ServerResponse<IncomingMessage>>
Returns Promise<InjectResultI<default, Response>>
- Defined in foxify/src/Foxify.ts:167

lookup

lookup(request: default, response: Response): void
Parameters
- request: default
- response: Response
Returns void
Inherited from Router.lookup
- Defined in router/src/Router.ts:187

on

on(method: MethodT | MethodT[], path: string, options?: undefined | null | false | OptionsI | HandlerT<default, Response> | HandlersT<default, Response>, ...handlers: HandlersT<default, Response>): default
Parameters
- method: MethodT | MethodT[]
- path: string
- options: undefined | null | false | OptionsI | HandlerT<default, Response> | HandlersT<default, Response> = {}
- Rest ...handlers: HandlersT<default, Response>
Returns default
Inherited from Router.on
- Defined in router/src/Router.ts:214

param

param(name: string, handler: HandlerT<default, Response>): default
Parameters
- name: string
- handler: HandlerT<default, Response>
Returns default
Inherited from Router.param
- Defined in router/src/Router.ts:384

prettyPrint

prettyPrint(): string
Returns visual representation of tree nodes

Returns string
Inherited from Router.prettyPrint
- Defined in router/src/Router.ts:398

route

route(path: string): RouteMethodsT<default, Response>
Parameters
- path: string
Returns RouteMethodsT<default, Response>
Inherited from Router.route
- Defined in router/src/Router.ts:402

`Protected` routes

routes(): RoutesT<default, Response>
Returns RoutesT<default, Response>
Inherited from Router.routes
- Defined in router/src/Router.ts:596

set

set<T>(setting: T, value: UserSettings[T]): default
Type Parameters
- T extends keyof UserSettings
Parameters
- setting: T
- value: UserSettings[T]
Returns default
- Defined in foxify/src/Foxify.ts:193

setting

setting<T>(setting: T): Settings[T]
Type Parameters
- T extends keyof Settings
Parameters
- setting: T
Returns Settings[T]
- Defined in foxify/src/Foxify.ts:288

start

start(callback?: Callback): Server
Parameters
- Optional callback: Callback
Returns Server
- Defined in foxify/src/Foxify.ts:297

`Protected` throw

throw(error: Error, request: default, response: Response): void
Parameters
- error: Error
- request: default
- response: Response
Returns void
Inherited from Router.throw
- Defined in router/src/Router.ts:600

use

use(...handlers: MiddlewaresT<default, Response>): default
Parameters
- Rest ...handlers: MiddlewaresT<default, Response>
Returns default
Inherited from Router.use
- Defined in router/src/Router.ts:419

`Static` dotenv

dotenv(path: string): void
Parameters
- path: string
Returns void
- Defined in foxify/src/Foxify.ts:132

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns default

Properties

Private _settings

Private Optional _view

acl

bind

Protected catchers

checkout

connect

copy

delete

get

head

link

lock

m-search

merge

Protected middlewares

mkactivity

mkcalendar

mkcol

move

notify

options

Protected Readonly paramHandlers

patch

post

Protected Readonly prefix

pri

propfind

proppatch

purge

put

rebind

report

search

source

subscribe

trace

Protected Readonly tree

unbind

unlink

unlock

unsubscribe

Static static

Methods

all

Parameters

path: string

Optional options: null | false | OptionsI | HandlerT<default, Response> | HandlersT<default, Response>

Rest ...handlers: HandlersT<default, Response>

Returns default

catch

Parameters

Rest ...handlers: ErrorHandlersT<default, Response>

Returns default

Protected defaultCatch

Parameters

error: Error

request: default

response: Response

Returns void

disable

Parameters

setting: keyof Settings

Returns default

disabled

Parameters

setting: keyof Settings

Returns boolean

enable

Parameters

`Private` _settings

`Private` `Optional` _view

`Protected` catchers

`Protected` middlewares

`Protected` `Readonly` paramHandlers

`Protected` `Readonly` prefix

`Protected` `Readonly` tree

`Static` static

`Optional` options: null | false | OptionsI | HandlerT<default, Response> | HandlersT<default, Response>

`Rest` ...handlers: HandlersT<default, Response>

`Rest` ...handlers: ErrorHandlersT<default, Response>

`Protected` defaultCatch

`Protected` generateCatchNext

`Protected` generateNext

`Rest` ...handlers: HandlersT<default, Response>

`Protected` routes