kylefang/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/zhigang1992/DefinitelyTyped.git synced 2026-04-21 05:20:24 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #7516 from jocull/restify

Browse Source 
Add router/routes support to Restify
This commit is contained in:
Masahiro Wakame
2016-01-11 22:08:05 +09:00
parent d3b5e127cc d2443f6855
commit 010d44dbd0
1 changed files with 101 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

135
restify/restify.d.ts vendored
View File

@@ -72,47 +72,111 @@ declare module "restify" {
headers: Object;
id: string;
}
interface Route {
name: string;
method: string;
path: RoutePathRegex;
spec: Object;
types: string[];
versions: string[];
}
interface RouteOptions {
name: string;
method: string;
path?: string | RegExp;
url?: string | RegExp;
urlParamPattern?: RegExp;
contentType?: string | string[];
versions?: string | string[];
}
interface RoutePathRegex extends RegExp {
restifyParams: string[];
}
interface Router {
name: string;
mounts: { [routeName: string]: Route };
versions: string[];
contentType: string[];
routes: {
DELETE: Route[];
GET: Route[];
HEAD: Route[];
OPTIONS: Route[];
PATCH: Route[];
POST: Route[];
PUT: Route[];
};
log?: any;
toString: () => string;
/**
* Takes an object of route params and query params, and 'renders' a URL
* @param {String} routeName the route name
* @param {Object} params an object of route params
* @param {Object} query an object of query params
* @returns {String}
*/
render: (routeName: string, params: Object, query?: Object) => string;
/**
* adds a route.
* @param {Object} options an options object
* @returns {String} returns the route name if creation is successful.
*/
mount: (options: Object) => string;
/**
* unmounts a route.
* @param {String} name the route name
* @returns {String} the name of the deleted route (or false if it was not matched)
*/
unmount: (name: string) => string | boolean;
}
interface Server extends http.Server {
use(handler: RequestHandler, ...handlers: RequestHandler[]): any;
use(handler: RequestHandler[], ...handlers: RequestHandler[]): any;
use(handler: RequestHandler, ...handlers: RequestHandler[][]): any;
use(handler: RequestHandler[], ...handlers: RequestHandler[][]): any;
use(handler: RequestHandler, ...handlers: RequestHandler[]): Server;
use(handler: RequestHandler[], ...handlers: RequestHandler[]): Server;
use(handler: RequestHandler, ...handlers: RequestHandler[][]): Server;
use(handler: RequestHandler[], ...handlers: RequestHandler[][]): Server;
post(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[]): any;
post(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[]): any;
post(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[][]): any;
post(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[][]): any;
post(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[]): Route;
post(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[]): Route;
post(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[][]): Route;
post(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[][]): Route;
patch(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[]): any;
patch(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[]): any;
patch(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[][]): any;
patch(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[][]): any;
patch(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[]): Route;
patch(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[]): Route;
patch(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[][]): Route;
patch(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[][]): Route;
put(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[]): any;
put(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[]): any;
put(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[][]): any;
put(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[][]): any;
put(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[]): Route;
put(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[]): Route;
put(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[][]): Route;
put(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[][]): Route;
del(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[]): any;
del(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[]): any;
del(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[][]): any;
del(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[][]): any;
del(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[]): Route;
del(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[]): Route;
del(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[][]): Route;
del(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[][]): Route;
get(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[]): any;
get(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[]): any;
get(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[][]): any;
get(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[][]): any;
get(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[]): Route;
get(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[]): Route;
get(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[][]): Route;
get(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[][]): Route;
head(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[]): any;
head(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[]): any;
head(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[][]): any;
head(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[][]): any;
head(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[]): Route;
head(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[]): Route;
head(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[][]): Route;
head(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[][]): Route;
opts(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[]): any;
opts(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[]): any;
opts(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[][]): any;
opts(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[][]): any;
opts(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[]): Route;
opts(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[]): Route;
opts(route: any, routeCallBack: RequestHandler, ...routeCallBacks: RequestHandler[][]): Route;
opts(route: any, routeCallBack: RequestHandler[], ...routeCallBacks: RequestHandler[][]): Route;
name: string;
version: string;
@@ -122,9 +186,11 @@ declare module "restify" {
address: () => addressInterface;
listen(... args: any[]): any;
close(... args: any[]): any;
pre(routeCallBack: RequestHandler): any;
pre(routeCallBack: RequestHandler): Server;
server: http.Server;
router: Router;
routes: Route[];
toString: () => string;
}
interface ServerOptions {
@@ -138,6 +204,7 @@ declare module "restify" {
responseTimeHeader ?: string;
responseTimeFormatter ?: (durationInMilliseconds: number) => any;
handleUpgrades ?: boolean;
router ?: Router;
}
interface ClientOptions {