No OneTemporary
Actions

Size

31 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/index.d.ts b/index.d.ts
	index c71bf70..355e206 100644
	--- a/index.d.ts
	+++ b/index.d.ts
	@@ -1,529 +1,555 @@
	// Type definitions for @koa/router 8.x
	// Project: https://github.com/koajs/koa-router#readme
	// Definitions by: Jerry Chin <https://github.com/hellopao>
	// Pavel Ivanov <https://github.com/schfkt>
	// JounQin <https://github.com/JounQin>
	// Romain Faust <https://github.com/romain-faust>
	// Guillaume Mayer <https://github.com/Guillaume-Mayer>
	// Andrea Gueugnaut <https://github.com/falinor>
	// Jeremy Forsythe <https://github.com/jdforsythe>
	// Definitions: https://github.com/hellopao/DefinitelyTyped
	// TypeScript Version: 2.3

	/* =================== USAGE ===================

	import * as Router from "@koa/router";
	var router = new Router();

	=============================================== */

	- import * as Koa from "koa";
	-
	- declare namespace Router {
	- interface RouterOptions {
	- /**
	- * Prefix for all routes.
	- */
	- prefix?: string;
	- /**
	- * Methods which should be supported by the router.
	- */
	- methods?: string[];
	- routerPath?: string;
	- /**
	- * Whether or not routing should be case-sensitive.
	- */
	- sensitive?: boolean;
	- /**
	- * Whether or not routes should matched strictly.
	- *
	- * If strict matching is enabled, the trailing slash is taken into
	- * account when matching routes.
	- */
	- strict?: boolean;
	- }
	-
	- interface RouterParamContext<StateT = any, CustomT = {}> {
	- /**
	- * url params
	- */
	- params: any;
	- /**
	- * the router instance
	- */
	- router: Router<StateT, CustomT>;
	- /**
	- * Matched route
	- */
	- _matchedRoute: string \| RegExp \| undefined;
	- _matchedRouteName: string \| undefined;
	- }
	-
	- type RouterContext<StateT = any, CustomT = {}> = Koa.ParameterizedContext<StateT, CustomT & RouterParamContext<StateT, CustomT>>;
	-
	- type Middleware<StateT = any, CustomT = {}> = Koa.Middleware<StateT, CustomT & RouterParamContext<StateT, CustomT>>;
	-
	- interface ParamMiddleware {
	- (param: string, ctx: RouterContext, next: Koa.Next): any;
	- }
	-
	- interface RouterAllowedMethodsOptions {
	- /**
	- * throw error instead of setting status and header
	- */
	- throw?: boolean;
	- /**
	- * throw the returned value in place of the default NotImplemented error
	- */
	- notImplemented?: () => any;
	- /**
	- * throw the returned value in place of the default MethodNotAllowed error
	- */
	- methodNotAllowed?: () => any;
	- }
	-
	- interface LayerOptions {
	- name: string;
	- sensitive?: boolean;
	- strict?: boolean;
	- end?: boolean;
	- prefix?: string;
	- ignoreCaptures?: boolean;
	- }
	-
	- interface UrlOptionsQuery {
	- query: object \| string;
	- }
	-
	- interface RoutesMatch {
	- path: Layer[];
	- pathAndMethod: Layer[];
	- route: boolean;
	- }
	-
	- class ParamName {
	- asterisk: boolean;
	- delimiter: string;
	- name: string;
	- optional: boolean;
	- partial: boolean;
	- pattern: string;
	- prefix: string;
	- repeat: string;
	- }
	-
	- class Layer {
	- opts: LayerOptions;
	- name: string;
	- methods: string[];
	- paramNames: ParamName[];
	- stack: Middleware[];
	- regexp: RegExp;
	- path: string;
	-
	- constructor(path: string \| RegExp, methods: string[], middleware: Middleware \| Middleware[], opts?: LayerOptions);
	-
	- /**
	- * Returns whether request `path` matches route.
	- */
	- match(path: string): boolean;
	-
	- /**
	- * Returns map of URL parameters for given `path` and `paramNames`.
	- */
	- params(path: string \| RegExp, captures: string[], existingParams?: object): object;
	-
	- /**
	- * Returns array of regexp url path captures.
	- */
	- captures(path: string): string[];
	-
	- /**
	- * Generate URL for route using given `params`.
	- */
	- url(params: object): string;
	-
	- /**
	- * Run validations on route named parameters.
	- */
	- param(param: string, fn: Middleware): Layer;
	-
	- /**
	- * Prefix route path.
	- */
	- setPrefix(prefix: string): Layer;
	- }
	-}
	-
	-declare class Router<StateT = any, CustomT = {}> {
	- params: object;
	- stack: Router.Layer[];
	+import * as Koa from "koa";

	+declare namespace Router {
	+ interface RouterOptions {
	/**
	- * Create a new router.
	+ * Prefix for all routes.
	*/
	- constructor(opt?: Router.RouterOptions);
	-
	+ prefix?: string;
	/**
	- * Use given middleware.
	- *
	- * Middleware run in the order they are defined by `.use()`. They are invoked
	- * sequentially, requests start at the first middleware and work their way
	- * "down" the middleware stack.
	+ * Methods which should be supported by the router.
	*/
	- use(...middleware: Array<Router.Middleware<StateT, CustomT>>): Router<StateT, CustomT>;
	- use(
	- path: string \| string[] \| RegExp,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	-
	+ methods?: string[];
	+ routerPath?: string;
	/**
	- * HTTP get method
	+ * Whether or not routing should be case-sensitive.
	*/
	- get(
	- name: string,
	- path: string \| RegExp,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	- get(
	- path: string \| RegExp \| Array<string \| RegExp>,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	- get<T, U>(
	- name: string,
	- path: string \| RegExp,
	- middleware: Koa.Middleware<T, U>,
	- routeHandler: Router.Middleware<StateT & T, CustomT & U>
	- ): Router<StateT & T, CustomT & U>;
	- get<T, U>(
	- path: string \| RegExp \| Array<string \| RegExp>,
	- middleware: Koa.Middleware<T, U>,
	- routeHandler: Router.Middleware<StateT & T, CustomT & U>
	- ): Router<StateT & T, CustomT & U>;
	-
	+ sensitive?: boolean;
	/**
	- * HTTP post method
	- */
	- post(
	- name: string,
	- path: string \| RegExp,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	- post(
	- path: string \| RegExp \| Array<string \| RegExp>,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	- post<T, U>(
	- name: string,
	- path: string \| RegExp,
	- middleware: Koa.Middleware<T, U>,
	- routeHandler: Router.Middleware<StateT & T, CustomT & U>
	- ): Router<StateT & T, CustomT & U>;
	- post<T, U>(
	- path: string \| RegExp \| Array<string \| RegExp>,
	- middleware: Koa.Middleware<T, U>,
	- routeHandler: Router.Middleware<StateT & T, CustomT & U>
	- ): Router<StateT & T, CustomT & U>;
	-
	- /**
	- * HTTP put method
	- */
	- put(
	- name: string,
	- path: string \| RegExp,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	- put(
	- path: string \| RegExp \| Array<string \| RegExp>,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	- put<T, U>(
	- name: string,
	- path: string \| RegExp,
	- middleware: Koa.Middleware<T, U>,
	- routeHandler: Router.Middleware<StateT & T, CustomT & U>
	- ): Router<StateT & T, CustomT & U>;
	- put<T, U>(
	- path: string \| RegExp \| Array<string \| RegExp>,
	- middleware: Koa.Middleware<T, U>,
	- routeHandler: Router.Middleware<StateT & T, CustomT & U>
	- ): Router<StateT & T, CustomT & U>;
	-
	- /**
	- * HTTP link method
	- */
	- link(
	- name: string,
	- path: string \| RegExp,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	- link(
	- path: string \| RegExp \| Array<string \| RegExp>,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	- link<T, U>(
	- name: string,
	- path: string \| RegExp,
	- middleware: Koa.Middleware<T, U>,
	- routeHandler: Router.Middleware<StateT & T, CustomT & U>
	- ): Router<StateT & T, CustomT & U>;
	- link<T, U>(
	- path: string \| RegExp \| Array<string \| RegExp>,
	- middleware: Koa.Middleware<T, U>,
	- routeHandler: Router.Middleware<StateT & T, CustomT & U>
	- ): Router<StateT & T, CustomT & U>;
	-
	- /**
	- * HTTP unlink method
	- */
	- unlink(
	- name: string,
	- path: string \| RegExp,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	- unlink(
	- path: string \| RegExp \| Array<string \| RegExp>,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	- unlink<T, U>(
	- name: string,
	- path: string \| RegExp,
	- middleware: Koa.Middleware<T, U>,
	- routeHandler: Router.Middleware<StateT & T, CustomT & U>
	- ): Router<StateT & T, CustomT & U>;
	- unlink<T, U>(
	- path: string \| RegExp \| Array<string \| RegExp>,
	- middleware: Koa.Middleware<T, U>,
	- routeHandler: Router.Middleware<StateT & T, CustomT & U>
	- ): Router<StateT & T, CustomT & U>;
	-
	- /**
	- * HTTP delete method
	+ * Whether or not routes should matched strictly.
	+ *
	+ * If strict matching is enabled, the trailing slash is taken into
	+ * account when matching routes.
	*/
	- delete(
	- name: string,
	- path: string \| RegExp,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	- delete(
	- path: string \| RegExp \| Array<string \| RegExp>,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	- delete<T, U>(
	- name: string,
	- path: string \| RegExp,
	- middleware: Koa.Middleware<T, U>,
	- routeHandler: Router.Middleware<StateT & T, CustomT & U>
	- ): Router<StateT & T, CustomT & U>;
	- delete<T, U>(
	- path: string \| RegExp \| Array<string \| RegExp>,
	- middleware: Koa.Middleware<T, U>,
	- routeHandler: Router.Middleware<StateT & T, CustomT & U>
	- ): Router<StateT & T, CustomT & U>;
	+ strict?: boolean;
	+ }

	+ interface RouterParamContext<StateT = any, CustomT = {}> {
	/**
	- * Alias for `router.delete()` because delete is a reserved word
	+ * url params
	*/
	- del(
	- name: string,
	- path: string \| RegExp,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	- del(
	- path: string \| RegExp \| Array<string \| RegExp>,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	- del<T, U>(
	- name: string,
	- path: string \| RegExp,
	- middleware: Koa.Middleware<T, U>,
	- routeHandler: Router.Middleware<StateT & T, CustomT & U>
	- ): Router<StateT & T, CustomT & U>;
	- del<T, U>(
	- path: string \| RegExp \| Array<string \| RegExp>,
	- middleware: Koa.Middleware<T, U>,
	- routeHandler: Router.Middleware<StateT & T, CustomT & U>
	- ): Router<StateT & T, CustomT & U>;
	-
	+ params: Record<string, string>;
	/**
	- * HTTP head method
	+ * the router instance
	*/
	- head(
	- name: string,
	- path: string \| RegExp,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	- head(
	- path: string \| RegExp \| Array<string \| RegExp>,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	- head<T, U>(
	- name: string,
	- path: string \| RegExp,
	- middleware: Koa.Middleware<T, U>,
	- routeHandler: Router.Middleware<StateT & T, CustomT & U>
	- ): Router<StateT & T, CustomT & U>;
	- head<T, U>(
	- path: string \| RegExp \| Array<string \| RegExp>,
	- middleware: Koa.Middleware<T, U>,
	- routeHandler: Router.Middleware<StateT & T, CustomT & U>
	- ): Router<StateT & T, CustomT & U>;
	-
	+ router: Router<StateT, CustomT>;
	/**
	- * HTTP options method
	+ * Matched route
	*/
	- options(
	- name: string,
	- path: string \| RegExp,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	- options(
	- path: string \| RegExp \| Array<string \| RegExp>,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	- options<T, U>(
	- name: string,
	- path: string \| RegExp,
	- middleware: Koa.Middleware<T, U>,
	- routeHandler: Router.Middleware<StateT & T, CustomT & U>
	- ): Router<StateT & T, CustomT & U>;
	- options<T, U>(
	- path: string \| RegExp \| Array<string \| RegExp>,
	- middleware: Koa.Middleware<T, U>,
	- routeHandler: Router.Middleware<StateT & T, CustomT & U>
	- ): Router<StateT & T, CustomT & U>;
	+ _matchedRoute: string \| RegExp \| undefined;
	+ _matchedRouteName: string \| undefined;
	+ }

	- /**
	- * HTTP patch method
	- */
	- patch(
	- name: string,
	- path: string \| RegExp,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	- patch(
	- path: string \| RegExp \| Array<string \| RegExp>,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	- patch<T, U>(
	- name: string,
	- path: string \| RegExp,
	- middleware: Koa.Middleware<T, U>,
	- routeHandler: Router.Middleware<StateT & T, CustomT & U>
	- ): Router<StateT & T, CustomT & U>;
	- patch<T, U>(
	- path: string \| RegExp \| Array<string \| RegExp>,
	- middleware: Koa.Middleware<T, U>,
	- routeHandler: Router.Middleware<StateT & T, CustomT & U>
	- ): Router<StateT & T, CustomT & U>;
	+ type RouterContext<StateT = any, CustomT = {}> = Koa.ParameterizedContext<
	+ StateT,
	+ CustomT & RouterParamContext<StateT, CustomT>
	+ >;

	- /**
	- * Register route with all methods.
	- */
	- all(
	- name: string,
	- path: string \| RegExp,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	- all(
	- path: string \| RegExp \| Array<string \| RegExp>,
	- ...middleware: Array<Router.Middleware<StateT, CustomT>>
	- ): Router<StateT, CustomT>;
	- all<T, U>(
	- name: string,
	- path: string \| RegExp,
	- middleware: Koa.Middleware<T, U>,
	- routeHandler: Router.Middleware<StateT & T, CustomT & U>
	- ): Router<StateT & T, CustomT & U>;
	- all<T, U>(
	- path: string \| RegExp \| Array<string \| RegExp>,
	- middleware: Koa.Middleware<T, U>,
	- routeHandler: Router.Middleware<StateT & T, CustomT & U>
	- ): Router<StateT & T, CustomT & U>;
	+ type Middleware<StateT = any, CustomT = {}> = Koa.Middleware<
	+ StateT,
	+ CustomT & RouterParamContext<StateT, CustomT>
	+ >;

	- /**
	- * Set the path prefix for a Router instance that was already initialized.
	- */
	- prefix(prefix: string): Router<StateT, CustomT>;
	+ interface ParamMiddleware {
	+ (param: string, ctx: RouterContext, next: Koa.Next): any;
	+ }

	+ interface RouterAllowedMethodsOptions {
	/**
	- * Returns router middleware which dispatches a route matching the request.
	+ * throw error instead of setting status and header
	*/
	- routes(): Router.Middleware<StateT, CustomT>;
	-
	+ throw?: boolean;
	/**
	- * Returns router middleware which dispatches a route matching the request.
	+ * throw the returned value in place of the default NotImplemented error
	*/
	- middleware(): Router.Middleware<StateT, CustomT>;
	-
	+ notImplemented?: () => any;
	/**
	- * Returns separate middleware for responding to `OPTIONS` requests with
	- * an `Allow` header containing the allowed methods, as well as responding
	- * with `405 Method Not Allowed` and `501 Not Implemented` as appropriate.
	+ * throw the returned value in place of the default MethodNotAllowed error
	*/
	- allowedMethods(
	- options?: Router.RouterAllowedMethodsOptions
	- ): Router.Middleware<StateT, CustomT>;
	+ methodNotAllowed?: () => any;
	+ }
	+
	+ interface LayerOptions {
	+ name: string;
	+ sensitive?: boolean;
	+ strict?: boolean;
	+ end?: boolean;
	+ prefix?: string;
	+ ignoreCaptures?: boolean;
	+ }
	+
	+ interface UrlOptionsQuery {
	+ query: object \| string;
	+ }
	+
	+ interface RoutesMatch {
	+ path: Layer[];
	+ pathAndMethod: Layer[];
	+ route: boolean;
	+ }
	+
	+ class ParamName {
	+ asterisk: boolean;
	+ delimiter: string;
	+ name: string;
	+ optional: boolean;
	+ partial: boolean;
	+ pattern: string;
	+ prefix: string;
	+ repeat: string;
	+ }
	+
	+ class Layer {
	+ opts: LayerOptions;
	+ name: string;
	+ methods: string[];
	+ paramNames: ParamName[];
	+ stack: Middleware[];
	+ regexp: RegExp;
	+ path: string;
	+
	+ constructor(
	+ path: string \| RegExp,
	+ methods: string[],
	+ middleware: Middleware \| Middleware[],
	+ opts?: LayerOptions
	+ );

	/**
	- * Redirect `source` to `destination` URL with optional 30x status `code`.
	- *
	- * Both `source` and `destination` can be route names.
	+ * Returns whether request `path` matches route.
	*/
	- redirect(source: string, destination: string, code?: number): Router<StateT, CustomT>;
	+ match(path: string): boolean;

	/**
	- * Create and register a route.
	+ * Returns map of URL parameters for given `path` and `paramNames`.
	*/
	- register(
	- path: string \| RegExp,
	- methods: string[],
	- middleware: Router.Middleware<StateT, CustomT> \| Array<Router.Middleware<StateT, CustomT>>,
	- opts?: Router.LayerOptions,
	- ): Router.Layer;
	+ params(
	+ path: string \| RegExp,
	+ captures: string[],
	+ existingParams?: object
	+ ): object;

	/**
	- * Lookup route with given `name`.
	+ * Returns array of regexp url path captures.
	*/
	- route(name: string): Router.Layer;
	- route(name: string): boolean;
	+ captures(path: string): string[];

	/**
	- * Generate URL for route. Takes either map of named `params` or series of
	- * arguments (for regular expression routes)
	- *
	- * router = new Router();
	- * router.get('user', "/users/:id", ...
	- *
	- * router.url('user', { id: 3 });
	- * // => "/users/3"
	- *
	- * Query can be generated from third argument:
	- *
	- * router.url('user', { id: 3 }, { query: { limit: 1 } });
	- * // => "/users/3?limit=1"
	- *
	- * router.url('user', { id: 3 }, { query: "limit=1" });
	- * // => "/users/3?limit=1"
	- *
	+ * Generate URL for route using given `params`.
	*/
	- url(name: string, params?: any, options?: Router.UrlOptionsQuery): string;
	- url(name: string, params?: any, options?: Router.UrlOptionsQuery): Error;
	+ url(params: object): string;

	/**
	- * Match given `path` and return corresponding routes.
	+ * Run validations on route named parameters.
	*/
	- match(path: string, method: string): Router.RoutesMatch;
	+ param(param: string, fn: Middleware): Layer;

	/**
	- * Run middleware for named route parameters. Useful for auto-loading or validation.
	+ * Prefix route path.
	*/
	- param(param: string, middleware: Router.ParamMiddleware): Router<StateT, CustomT>;
	+ setPrefix(prefix: string): Layer;
	+ }
	+}

	- /**
	- * Generate URL from url pattern and given `params`.
	- */
	- static url(path: string \| RegExp, params: object): string;
	- }
	+declare class Router<StateT = any, CustomT = {}> {
	+ params: object;
	+ stack: Router.Layer[];
	+
	+ /**
	+ * Create a new router.
	+ */
	+ constructor(opt?: Router.RouterOptions);
	+
	+ /**
	+ * Use given middleware.
	+ *
	+ * Middleware run in the order they are defined by `.use()`. They are invoked
	+ * sequentially, requests start at the first middleware and work their way
	+ * "down" the middleware stack.
	+ */
	+ use(
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ use(
	+ path: string \| string[] \| RegExp,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+
	+ /**
	+ * HTTP get method
	+ */
	+ get(
	+ name: string,
	+ path: string \| RegExp,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ get(
	+ path: string \| RegExp \| Array<string \| RegExp>,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ get<T, U>(
	+ name: string,
	+ path: string \| RegExp,
	+ middleware: Koa.Middleware<T, U>,
	+ routeHandler: Router.Middleware<StateT & T, CustomT & U>
	+ ): Router<StateT & T, CustomT & U>;
	+ get<T, U>(
	+ path: string \| RegExp \| Array<string \| RegExp>,
	+ middleware: Koa.Middleware<T, U>,
	+ routeHandler: Router.Middleware<StateT & T, CustomT & U>
	+ ): Router<StateT & T, CustomT & U>;
	+
	+ /**
	+ * HTTP post method
	+ */
	+ post(
	+ name: string,
	+ path: string \| RegExp,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ post(
	+ path: string \| RegExp \| Array<string \| RegExp>,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ post<T, U>(
	+ name: string,
	+ path: string \| RegExp,
	+ middleware: Koa.Middleware<T, U>,
	+ routeHandler: Router.Middleware<StateT & T, CustomT & U>
	+ ): Router<StateT & T, CustomT & U>;
	+ post<T, U>(
	+ path: string \| RegExp \| Array<string \| RegExp>,
	+ middleware: Koa.Middleware<T, U>,
	+ routeHandler: Router.Middleware<StateT & T, CustomT & U>
	+ ): Router<StateT & T, CustomT & U>;
	+
	+ /**
	+ * HTTP put method
	+ */
	+ put(
	+ name: string,
	+ path: string \| RegExp,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ put(
	+ path: string \| RegExp \| Array<string \| RegExp>,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ put<T, U>(
	+ name: string,
	+ path: string \| RegExp,
	+ middleware: Koa.Middleware<T, U>,
	+ routeHandler: Router.Middleware<StateT & T, CustomT & U>
	+ ): Router<StateT & T, CustomT & U>;
	+ put<T, U>(
	+ path: string \| RegExp \| Array<string \| RegExp>,
	+ middleware: Koa.Middleware<T, U>,
	+ routeHandler: Router.Middleware<StateT & T, CustomT & U>
	+ ): Router<StateT & T, CustomT & U>;
	+
	+ /**
	+ * HTTP link method
	+ */
	+ link(
	+ name: string,
	+ path: string \| RegExp,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ link(
	+ path: string \| RegExp \| Array<string \| RegExp>,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ link<T, U>(
	+ name: string,
	+ path: string \| RegExp,
	+ middleware: Koa.Middleware<T, U>,
	+ routeHandler: Router.Middleware<StateT & T, CustomT & U>
	+ ): Router<StateT & T, CustomT & U>;
	+ link<T, U>(
	+ path: string \| RegExp \| Array<string \| RegExp>,
	+ middleware: Koa.Middleware<T, U>,
	+ routeHandler: Router.Middleware<StateT & T, CustomT & U>
	+ ): Router<StateT & T, CustomT & U>;
	+
	+ /**
	+ * HTTP unlink method
	+ */
	+ unlink(
	+ name: string,
	+ path: string \| RegExp,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ unlink(
	+ path: string \| RegExp \| Array<string \| RegExp>,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ unlink<T, U>(
	+ name: string,
	+ path: string \| RegExp,
	+ middleware: Koa.Middleware<T, U>,
	+ routeHandler: Router.Middleware<StateT & T, CustomT & U>
	+ ): Router<StateT & T, CustomT & U>;
	+ unlink<T, U>(
	+ path: string \| RegExp \| Array<string \| RegExp>,
	+ middleware: Koa.Middleware<T, U>,
	+ routeHandler: Router.Middleware<StateT & T, CustomT & U>
	+ ): Router<StateT & T, CustomT & U>;
	+
	+ /**
	+ * HTTP delete method
	+ */
	+ delete(
	+ name: string,
	+ path: string \| RegExp,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ delete(
	+ path: string \| RegExp \| Array<string \| RegExp>,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ delete<T, U>(
	+ name: string,
	+ path: string \| RegExp,
	+ middleware: Koa.Middleware<T, U>,
	+ routeHandler: Router.Middleware<StateT & T, CustomT & U>
	+ ): Router<StateT & T, CustomT & U>;
	+ delete<T, U>(
	+ path: string \| RegExp \| Array<string \| RegExp>,
	+ middleware: Koa.Middleware<T, U>,
	+ routeHandler: Router.Middleware<StateT & T, CustomT & U>
	+ ): Router<StateT & T, CustomT & U>;
	+
	+ /**
	+ * Alias for `router.delete()` because delete is a reserved word
	+ */
	+ del(
	+ name: string,
	+ path: string \| RegExp,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ del(
	+ path: string \| RegExp \| Array<string \| RegExp>,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ del<T, U>(
	+ name: string,
	+ path: string \| RegExp,
	+ middleware: Koa.Middleware<T, U>,
	+ routeHandler: Router.Middleware<StateT & T, CustomT & U>
	+ ): Router<StateT & T, CustomT & U>;
	+ del<T, U>(
	+ path: string \| RegExp \| Array<string \| RegExp>,
	+ middleware: Koa.Middleware<T, U>,
	+ routeHandler: Router.Middleware<StateT & T, CustomT & U>
	+ ): Router<StateT & T, CustomT & U>;
	+
	+ /**
	+ * HTTP head method
	+ */
	+ head(
	+ name: string,
	+ path: string \| RegExp,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ head(
	+ path: string \| RegExp \| Array<string \| RegExp>,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ head<T, U>(
	+ name: string,
	+ path: string \| RegExp,
	+ middleware: Koa.Middleware<T, U>,
	+ routeHandler: Router.Middleware<StateT & T, CustomT & U>
	+ ): Router<StateT & T, CustomT & U>;
	+ head<T, U>(
	+ path: string \| RegExp \| Array<string \| RegExp>,
	+ middleware: Koa.Middleware<T, U>,
	+ routeHandler: Router.Middleware<StateT & T, CustomT & U>
	+ ): Router<StateT & T, CustomT & U>;
	+
	+ /**
	+ * HTTP options method
	+ */
	+ options(
	+ name: string,
	+ path: string \| RegExp,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ options(
	+ path: string \| RegExp \| Array<string \| RegExp>,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ options<T, U>(
	+ name: string,
	+ path: string \| RegExp,
	+ middleware: Koa.Middleware<T, U>,
	+ routeHandler: Router.Middleware<StateT & T, CustomT & U>
	+ ): Router<StateT & T, CustomT & U>;
	+ options<T, U>(
	+ path: string \| RegExp \| Array<string \| RegExp>,
	+ middleware: Koa.Middleware<T, U>,
	+ routeHandler: Router.Middleware<StateT & T, CustomT & U>
	+ ): Router<StateT & T, CustomT & U>;
	+
	+ /**
	+ * HTTP patch method
	+ */
	+ patch(
	+ name: string,
	+ path: string \| RegExp,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ patch(
	+ path: string \| RegExp \| Array<string \| RegExp>,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ patch<T, U>(
	+ name: string,
	+ path: string \| RegExp,
	+ middleware: Koa.Middleware<T, U>,
	+ routeHandler: Router.Middleware<StateT & T, CustomT & U>
	+ ): Router<StateT & T, CustomT & U>;
	+ patch<T, U>(
	+ path: string \| RegExp \| Array<string \| RegExp>,
	+ middleware: Koa.Middleware<T, U>,
	+ routeHandler: Router.Middleware<StateT & T, CustomT & U>
	+ ): Router<StateT & T, CustomT & U>;
	+
	+ /**
	+ * Register route with all methods.
	+ */
	+ all(
	+ name: string,
	+ path: string \| RegExp,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ all(
	+ path: string \| RegExp \| Array<string \| RegExp>,
	+ ...middleware: Array<Router.Middleware<StateT, CustomT>>
	+ ): Router<StateT, CustomT>;
	+ all<T, U>(
	+ name: string,
	+ path: string \| RegExp,
	+ middleware: Koa.Middleware<T, U>,
	+ routeHandler: Router.Middleware<StateT & T, CustomT & U>
	+ ): Router<StateT & T, CustomT & U>;
	+ all<T, U>(
	+ path: string \| RegExp \| Array<string \| RegExp>,
	+ middleware: Koa.Middleware<T, U>,
	+ routeHandler: Router.Middleware<StateT & T, CustomT & U>
	+ ): Router<StateT & T, CustomT & U>;
	+
	+ /**
	+ * Set the path prefix for a Router instance that was already initialized.
	+ */
	+ prefix(prefix: string): Router<StateT, CustomT>;
	+
	+ /**
	+ * Returns router middleware which dispatches a route matching the request.
	+ */
	+ routes(): Router.Middleware<StateT, CustomT>;
	+
	+ /**
	+ * Returns router middleware which dispatches a route matching the request.
	+ */
	+ middleware(): Router.Middleware<StateT, CustomT>;
	+
	+ /**
	+ * Returns separate middleware for responding to `OPTIONS` requests with
	+ * an `Allow` header containing the allowed methods, as well as responding
	+ * with `405 Method Not Allowed` and `501 Not Implemented` as appropriate.
	+ */
	+ allowedMethods(
	+ options?: Router.RouterAllowedMethodsOptions
	+ ): Router.Middleware<StateT, CustomT>;
	+
	+ /**
	+ * Redirect `source` to `destination` URL with optional 30x status `code`.
	+ *
	+ * Both `source` and `destination` can be route names.
	+ */
	+ redirect(
	+ source: string,
	+ destination: string,
	+ code?: number
	+ ): Router<StateT, CustomT>;
	+
	+ /**
	+ * Create and register a route.
	+ */
	+ register(
	+ path: string \| RegExp,
	+ methods: string[],
	+ middleware:
	+ \| Router.Middleware<StateT, CustomT>
	+ \| Array<Router.Middleware<StateT, CustomT>>,
	+ opts?: Router.LayerOptions
	+ ): Router.Layer;
	+
	+ /**
	+ * Lookup route with given `name`.
	+ */
	+ route(name: string): Router.Layer;
	+ route(name: string): boolean;
	+
	+ /**
	+ * Generate URL for route. Takes either map of named `params` or series of
	+ * arguments (for regular expression routes)
	+ *
	+ * router = new Router();
	+ * router.get('user', "/users/:id", ...
	+ *
	+ * router.url('user', { id: 3 });
	+ * // => "/users/3"
	+ *
	+ * Query can be generated from third argument:
	+ *
	+ * router.url('user', { id: 3 }, { query: { limit: 1 } });
	+ * // => "/users/3?limit=1"
	+ *
	+ * router.url('user', { id: 3 }, { query: "limit=1" });
	+ * // => "/users/3?limit=1"
	+ *
	+ */
	+ url(name: string, params?: any, options?: Router.UrlOptionsQuery): string;
	+ url(name: string, params?: any, options?: Router.UrlOptionsQuery): Error;
	+
	+ /**
	+ * Match given `path` and return corresponding routes.
	+ */
	+ match(path: string, method: string): Router.RoutesMatch;
	+
	+ /**
	+ * Run middleware for named route parameters. Useful for auto-loading or validation.
	+ */
	+ param(
	+ param: string,
	+ middleware: Router.ParamMiddleware
	+ ): Router<StateT, CustomT>;
	+
	+ /**
	+ * Generate URL from url pattern and given `params`.
	+ */
	+ static url(path: string \| RegExp, params: object): string;
	+}

	- export = Router;
	+export = Router;

File Metadata

Mime Type: text/x-diff
Expires: Mon, Dec 23, 07:00 (1 d, 2 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 556845
Default Alt Text: (31 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions