Class KoaRouterClient

acl

all

bind

checkout

connect

copy

delete

get

head

link

lock

m-search

merge

mkactivity

mkcalendar

mkcol

move

notify

options

patch

post

propfind

proppatch

purge

put

rebind

report

search

source

subscribe

trace

unbind

unlink

unlock

unsubscribe

Static acl

Static all

Static bind

Static checkout

Static connect

Static copy

Static delete

Static get

Static head

Static link

Static lock

Static m-search

Static merge

Static mkactivity

Static mkcalendar

Static mkcol

Static move

Static notify

Static options

Static patch

Static post

Static propfind

Static proppatch

Static purge

Static put

Static rebind

Static report

Static search

Static source

Static subscribe

Static trace

Static unbind

Static unlink

Static unlock

Static unsubscribe

addConstraintStrategy

• addConstraintStrategy(constraintStrategy): void

• Parameters

  • constraintStrategy: ConstraintStrategy<V1, string>

  Returns void

find

• find(method, path, constraints?): null | FindResult<V1>

• Parameters

  • method: HTTPMethod
  • path: string
  • Optional constraints: {
        [key: string]: any;
    }

    • [key: string]: any

  Returns null | FindResult<V1>

findRoute

• findRoute(method, path, constraints?): null | FindRouteResult<V1>

• Parameters

  • method: HTTPMethod
  • path: string
  • Optional constraints: {
        [key: string]: any;
    }

    • [key: string]: any

  Returns null | FindRouteResult<V1>

hasConstraintStrategy

• hasConstraintStrategy(strategyName): boolean

• Parameters

  • strategyName: string

  Returns boolean

hasRoute

• hasRoute(method, path, constraints?): boolean

• Parameters

  • method: HTTPMethod
  • path: string
  • Optional constraints: {
        [key: string]: any;
    }

    • [key: string]: any

  Returns boolean

lookup

• lookup<Context>(req, res, ctx?): any

• Type Parameters

  • Context

  Parameters

  • req: IncomingMessage
  • res: ServerResponse<IncomingMessage>
  • Optional ctx: Context

  Returns any

off

• off(method, path, constraints?): void

• Parameters

  • method: HTTPMethod | HTTPMethod[]
  • path: string
  • Optional constraints: {
        [key: string]: any;
    }

    • [key: string]: any

  Returns void

on

• on(method, path, handler): void

• Parameters

  • method: HTTPMethod | HTTPMethod[]
  • path: string
  • handler: Handler<V1>

  Returns void

• on(method, path, options, handler): void

• Parameters

  • method: HTTPMethod | HTTPMethod[]
  • path: string
  • options: RouteOptions
  • handler: Handler<V1>

  Returns void

• on(method, path, handler, store): void

• Parameters

  • method: HTTPMethod | HTTPMethod[]
  • path: string
  • handler: Handler<V1>
  • store: any

  Returns void

• on(method, path, options, handler, store): void

• Parameters

  • method: HTTPMethod | HTTPMethod[]
  • path: string
  • options: RouteOptions
  • handler: Handler<V1>
  • store: any

  Returns void

prettyPrint

• prettyPrint(): string

• Returns string

• prettyPrint(opts): string

• Parameters

  • opts: {
        commonPrefix?: boolean;
        includeMeta?: boolean | (string | symbol)[];
        method?: HTTPMethod;
    }

    • Optional commonPrefix?: boolean

    • Optional includeMeta?: boolean | (string | symbol)[]

    • Optional method?: HTTPMethod

  Returns string

reset

• reset(): void

• Returns void

Static addConstraintStrategy

• addConstraintStrategy(constraintStrategy): void

• Parameters

  • constraintStrategy: ConstraintStrategy<V1, string>

  Returns void

Static find

• find(method, path, constraints?): null | FindResult<V1>

• Parameters

  • method: HTTPMethod
  • path: string
  • Optional constraints: {
        [key: string]: any;
    }

    • [key: string]: any

  Returns null | FindResult<V1>

Static findRoute

• findRoute(method, path, constraints?): null | FindRouteResult<V1>

• Parameters

  • method: HTTPMethod
  • path: string
  • Optional constraints: {
        [key: string]: any;
    }

    • [key: string]: any

  Returns null | FindRouteResult<V1>

Static hasConstraintStrategy

• hasConstraintStrategy(strategyName): boolean

• Parameters

  • strategyName: string

  Returns boolean

Static hasRoute

• hasRoute(method, path, constraints?): boolean

• Parameters

  • method: HTTPMethod
  • path: string
  • Optional constraints: {
        [key: string]: any;
    }

    • [key: string]: any

  Returns boolean

Static lookup

• lookup<Context>(req, res, ctx?): any

• Type Parameters

  • Context

  Parameters

  • req: IncomingMessage
  • res: ServerResponse<IncomingMessage>
  • Optional ctx: Context

  Returns any

Static off

• off(method, path, constraints?): void

• Parameters

  • method: HTTPMethod | HTTPMethod[]
  • path: string
  • Optional constraints: {
        [key: string]: any;
    }

    • [key: string]: any

  Returns void

Static on

• on(method, path, handler): void

• Parameters

  • method: HTTPMethod | HTTPMethod[]
  • path: string
  • handler: Handler<V1>

  Returns void

• on(method, path, options, handler): void

• Parameters

  • method: HTTPMethod | HTTPMethod[]
  • path: string
  • options: RouteOptions
  • handler: Handler<V1>

  Returns void

• on(method, path, handler, store): void

• Parameters

  • method: HTTPMethod | HTTPMethod[]
  • path: string
  • handler: Handler<V1>
  • store: any

  Returns void

• on(method, path, options, handler, store): void

• Parameters

  • method: HTTPMethod | HTTPMethod[]
  • path: string
  • options: RouteOptions
  • handler: Handler<V1>
  • store: any

  Returns void

Static prettyPrint

• prettyPrint(): string

• Returns string

• prettyPrint(opts): string

• Parameters

  • opts: {
        commonPrefix?: boolean;
        includeMeta?: boolean | (string | symbol)[];
        method?: HTTPMethod;
    }

    • Optional commonPrefix?: boolean

    • Optional includeMeta?: boolean | (string | symbol)[]

    • Optional method?: HTTPMethod

  Returns string

Static reset

• reset(): void

• Returns void