@tsed/common
Version:
A TypeScript Framework on top of Express
129 lines (128 loc) • 6.28 kB
TypeScript
/**
* This method is just like the `router.METHOD()` methods, except that it matches all HTTP methods (verbs).
*
* This method is extremely useful for mapping “global” logic for specific path prefixes or arbitrary matches.
* For example, if you placed the following route at the top of all other route definitions, it would require that
* all routes from that point on would require authentication, and automatically load a user.
* Keep in mind that these callbacks do not have to act as end points; loadUser can perform a task, then call next()
* to continue matching subsequent routes.
* @param path
* @param args
* @returns {Function}
* @decorator
* @operation
* @httpMethod
*/
export declare function All(path?: string | RegExp | any, ...args: any[]): Function;
/**
* This method is just like the `router.METHOD()` methods, except that it matches all HTTP methods (verbs).
*
* This method is extremely useful for mapping “global” logic for specific path prefixes or arbitrary matches.
* For example, if you placed the following route at the top of all other route definitions, it would require that
* all routes from that point on would require authentication, and automatically load a user.
* Keep in mind that these callbacks do not have to act as end points; loadUser can perform a task, then call next()
* to continue matching subsequent routes.
* @param path
* @param args
* @returns {Function}
* @decorator
* @operation
* @httpMethod
*/
export declare function Get(path?: string | RegExp | any, ...args: any[]): Function;
/**
* This method is just like the `router.METHOD()` methods, except that it matches all HTTP methods (verbs).
*
* This method is extremely useful for mapping “global” logic for specific path prefixes or arbitrary matches.
* For example, if you placed the following route at the top of all other route definitions, it would require that
* all routes from that point on would require authentication, and automatically load a user.
* Keep in mind that these callbacks do not have to act as end points; loadUser can perform a task, then call next()
* to continue matching subsequent routes.
* @param path
* @param args
* @returns {Function}
* @decorator
* @operation
* @httpMethod
*/
export declare function Post(path?: string | RegExp | any, ...args: any[]): Function;
/**
* This method is just like the `router.METHOD()` methods, except that it matches all HTTP methods (verbs).
*
* This method is extremely useful for mapping “global” logic for specific path prefixes or arbitrary matches.
* For example, if you placed the following route at the top of all other route definitions, it would require that
* all routes from that point on would require authentication, and automatically load a user.
* Keep in mind that these callbacks do not have to act as end points; loadUser can perform a task, then call next()
* to continue matching subsequent routes.
* @param path
* @param args
* @returns {Function}
* @decorator
* @operation
* @httpMethod
*/
export declare function Put(path?: string | RegExp | any, ...args: any[]): Function;
/**
* This method is just like the `router.METHOD()` methods, except that it matches all HTTP methods (verbs).
*
* This method is extremely useful for mapping “global” logic for specific path prefixes or arbitrary matches.
* For example, if you placed the following route at the top of all other route definitions, it would require that
* all routes from that point on would require authentication, and automatically load a user.
* Keep in mind that these callbacks do not have to act as end points; loadUser can perform a task, then call next()
* to continue matching subsequent routes.
* @param path
* @param args
* @returns {Function}
* @decorator
* @operation
* @httpMethod
*/
export declare function Delete(path?: string | RegExp | any, ...args: any[]): Function;
/**
* This method is just like the `router.METHOD()` methods, except that it matches all HTTP methods (verbs).
*
* This method is extremely useful for mapping “global” logic for specific path prefixes or arbitrary matches.
* For example, if you placed the following route at the top of all other route definitions, it would require that
* all routes from that point on would require authentication, and automatically load a user.
* Keep in mind that these callbacks do not have to act as end points; loadUser can perform a task, then call next()
* to continue matching subsequent routes.
* @param path
* @param args
* @returns {Function}
* @decorator
* @operation
* @httpMethod
*/
export declare function Head(path?: string | RegExp | any, ...args: any[]): Function;
/**
* This method is just like the `router.METHOD()` methods, except that it matches all HTTP methods (verbs).
*
* This method is extremely useful for mapping “global” logic for specific path prefixes or arbitrary matches.
* For example, if you placed the following route at the top of all other route definitions, it would require that
* all routes from that point on would require authentication, and automatically load a user.
* Keep in mind that these callbacks do not have to act as end points; loadUser can perform a task, then call next()
* to continue matching subsequent routes.
* @param path
* @param args
* @returns {Function}
* @decorator
* @operation
* @httpMethod
*/
export declare function Patch(path?: string | RegExp | any, ...args: any[]): Function;
/**
* This method is just like the `router.METHOD()` methods, except that it matches all HTTP methods (verbs).
*
* This method is extremely useful for mapping “global” logic for specific path prefixes or arbitrary matches.
* For example, if you placed the following route at the top of all other route definitions, it would require that
* all routes from that point on would require authentication, and automatically load a user.
* Keep in mind that these callbacks do not have to act as end points; loadUser can perform a task, then call next()
* to continue matching subsequent routes.
* @param path
* @param args
* @returns {Function}
* @decorator
* @operation
* @httpMethod
*/
export declare function Options(path?: string | RegExp | any, ...args: any[]): Function;