resting-squirrel-controller 2.6.0 → 2.6.1

package/dist/controller.d.ts

@@ -1,257 +1,257 @@
-import { Application, Field, IRequest, IResponse, IRouteOptions, Response, RouteAuth } from 'resting-squirrel';
-import { ArgsDto, BaseDto, RequestDto, ResponseDto } from 'resting-squirrel-dto';
-import { IOptions, RSDtoType } from './decorators/options';
-export interface IStore {
-    __endpoints__: Array<IEndpoint>;
-    __options__: {
-        [propertyKey: string]: IOptions;
-    };
-    __deprecated__: Array<string>;
-}
-export interface IEndpoint {
-    method: 'get' | 'put' | 'post' | 'delete' | 'head';
-    route: string;
-    callback: (req: IRequest, res: any) => void | Promise<any>;
-    propertyKey: string;
-}
-declare class E {
-    /**
-     * The endpoint is executed with `PUT` method.
-     */
-    static put: (endpoint: string) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * The endpoint is executed with `GET` method.
-     */
-    static get: (endpoint: string) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * The endpoint is executed with `POST` method.
-     */
-    static post: (endpoint: string) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * The endpoint is executed with `DELETE` method.
-     */
-    static delete: (endpoint: string) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * The endpoint is executed with `HEAD` method.
-     */
-    static head: (endpoint: string) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Defines options to the endpoint.
-     */
-    static options: (options: Partial<IOptions<{
-        [key: string]: any;
-    }>>) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Define specific option to the endpoint.
-     */
-    static option: <K extends keyof IOptions<{
-        [key: string]: any;
-    }>>(option: K, value: IOptions<{
-        [key: string]: any;
-    }>[K]) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `auth` option of the endpoint.
-     */
-    static auth: (auth: RouteAuth) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `params` option to the endpoint using DTO classes.
-     */
-    static params: (params: RSDtoType | typeof BaseDto | typeof RequestDto, optionalParams?: Array<string>, omit?: Array<string>) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `response` option to the endpoint using DTO classes.
-     */
-    static response: (response: RSDtoType | typeof BaseDto | typeof ResponseDto | Response.Base, omit?: Array<string>) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `params` and `response` options to the endpoint using DTO classes.
-     */
-    static dto: (dto: RSDtoType | typeof BaseDto, optionalParams?: Array<string>, omitParams?: Array<string>, omitResponse?: Array<string>) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `errors` option to the endpoint.
-     */
-    static errors: (errors: IOptions['errors']) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `description` option to the endpoint.
-     */
-    static description: (description: string) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `hideDocs` option to `true` to the endpoint.
-     */
-    static hideDocs: (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `args` option to the endpoint.
-     */
-    static args: (args: Array<Field> | typeof ArgsDto) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `requireApiKey` option to the endpoint.
-     */
-    static requireApiKey: (requireApiKey: boolean) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `excludedApiKey` option to the endpoint.
-     */
-    static excludedApiKeys: (excludedApiKeys: (() => Promise<Array<string>>) | Array<string>) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `timeout` option to the endpoint.
-     */
-    static timeout: (timeout: number) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `props` option to the endpoint.
-     */
-    static props: <IProps = {
-        [key: string]: any;
-    }>(props: IProps) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the endpoint as empty. It returns 204 status code.
-     */
-    static emptyResponse: (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the endpoint as deprecated.
-     */
-    static deprecated: (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    static redirect: (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-}
-export default class Controller {
-    /**
-     * Sets the version to the `Controller` class. All endpoints will have this version.
-     */
-    static version: (version: number) => (target: typeof Controller) => void;
-    /**
-     * @alias version
-     */
-    static v: (version: number) => (target: typeof Controller) => void;
-    static controllerOptions: (options: Partial<import("./decorators/controller-options").IOptions<{
-        [key: string]: any;
-    }>>) => (target: typeof Controller) => void;
-    static resource: (resource: string) => (target: typeof Controller) => void;
-    static Endpoint: typeof E;
-    /**
-     * Marks the endpoint on the method as deprecated.
-     * @deprecated
-     */
-    static deprecated: (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * The endpoint is executed with `PUT` method.
-     * @deprecated
-     */
-    static put: (endpoint: string) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * The endpoint is executed with `GET` method.
-     * @deprecated
-     */
-    static get: (endpoint: string) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * The endpoint is executed with `POST` method.
-     * @deprecated
-     */
-    static post: (endpoint: string) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * The endpoint is executed with `DELETE` method.
-     * @deprecated
-     */
-    static delete: (endpoint: string) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Defines options to the endpoint.
-     * @deprecated
-     */
-    static options: (options: Partial<IOptions<{
-        [key: string]: any;
-    }>>) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Define specific option to the endpoint.
-     * @deprecated
-     */
-    static option: <K extends keyof IOptions<{
-        [key: string]: any;
-    }>>(option: K, value: IOptions<{
-        [key: string]: any;
-    }>[K]) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `auth` option of the endpoint.
-     * @deprecated
-     */
-    static auth: (auth: RouteAuth) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `params` option to the endpoint using DTO classes.
-     * @deprecated
-     */
-    static params: (params: RSDtoType | typeof BaseDto | typeof RequestDto, optionalParams?: Array<string>, omit?: Array<string>) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `response` option to the endpoint using DTO classes.
-     * @deprecated
-     */
-    static response: (response: RSDtoType | typeof BaseDto | typeof ResponseDto | Response.Base, omit?: Array<string>) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `params` and `response` options to the endpoint using DTO classes.
-     * @deprecated
-     */
-    static dto: (dto: RSDtoType | typeof BaseDto, optionalParams?: Array<string>, omitParams?: Array<string>, omitResponse?: Array<string>) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `errors` option to the endpoint.
-     * @deprecated
-     */
-    static errors: (errors: IOptions['errors']) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `description` option to the endpoint.
-     * @deprecated
-     */
-    static description: (description: string) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `hideDocs` option to `true` to the endpoint.
-     * @deprecated
-     */
-    static hideDocs: (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `args` option to the endpoint.
-     * @deprecated
-     */
-    static args: (args: Array<Field> | typeof ArgsDto) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `requireApiKey` option to the endpoint.
-     * @deprecated
-     */
-    static requireApiKey: (requireApiKey: boolean) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `excludedApiKey` option to the endpoint.
-     * @deprecated
-     */
-    static excludedApiKeys: (excludedApiKeys: (() => Promise<Array<string>>) | Array<string>) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `timeout` option to the endpoint.
-     * @deprecated
-     */
-    static timeout: (timeout: number) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the `props` option to the endpoint.
-     * @deprecated
-     */
-    static props: <IProps = {
-        [key: string]: any;
-    }>(props: IProps) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    /**
-     * Sets the endpoint as empty. It returns 204 status code.
-     * @deprecated
-     */
-    static emptyResponse: (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
-    private static _controllers;
-    /**
-     * Registers all found controllers in the directory to the application.
-     *
-     * @param app The instance of the application.
-     * @param directory Path to the directory where the controllers are located.
-     */
-    static registerDirectory(app: Application, directory: string): Promise<void>;
-    static register(app: Application): void;
-    static getControllers(): Controller[];
-    private _app;
-    constructor(app: Application);
-    register(): void;
-    beforeExecution(req: IRequest, res: IResponse): Promise<void>;
-    getEndpoints(): Array<IEndpoint>;
-    getVersion(): number;
-    getResource(): string;
-    getOptions(propertyKey: string): IRouteOptions;
-    isDeprecated(propertyKey: string): boolean;
-    getRoute(route: string): string;
-    private _getParamsArray;
-    private _getResponseArray;
-}
-export {};
+import { Application, Field, IRequest, IResponse, IRouteOptions, Response, RouteAuth } from 'resting-squirrel';
+import { ArgsDto, BaseDto, RequestDto, ResponseDto } from 'resting-squirrel-dto';
+import { IOptions, RSDtoType } from './decorators/options';
+export interface IStore {
+    __endpoints__: Array<IEndpoint>;
+    __options__: {
+        [propertyKey: string]: IOptions;
+    };
+    __deprecated__: Array<string>;
+}
+export interface IEndpoint {
+    method: 'get' | 'put' | 'post' | 'delete' | 'head';
+    route: string;
+    callback: (req: IRequest, res: any) => void | Promise<any>;
+    propertyKey: string;
+}
+declare class E {
+    /**
+     * The endpoint is executed with `PUT` method.
+     */
+    static put: (endpoint: string) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * The endpoint is executed with `GET` method.
+     */
+    static get: (endpoint: string) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * The endpoint is executed with `POST` method.
+     */
+    static post: (endpoint: string) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * The endpoint is executed with `DELETE` method.
+     */
+    static delete: (endpoint: string) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * The endpoint is executed with `HEAD` method.
+     */
+    static head: (endpoint: string) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Defines options to the endpoint.
+     */
+    static options: (options: Partial<IOptions<{
+        [key: string]: any;
+    }>>) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Define specific option to the endpoint.
+     */
+    static option: <K extends keyof IOptions<{
+        [key: string]: any;
+    }>>(option: K, value: IOptions<{
+        [key: string]: any;
+    }>[K]) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `auth` option of the endpoint.
+     */
+    static auth: (auth: RouteAuth) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `params` option to the endpoint using DTO classes.
+     */
+    static params: (params: RSDtoType | typeof BaseDto | typeof RequestDto, optionalParams?: Array<string>, omit?: Array<string>) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `response` option to the endpoint using DTO classes.
+     */
+    static response: (response: RSDtoType | typeof BaseDto | typeof ResponseDto | Response.Base, omit?: Array<string>) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `params` and `response` options to the endpoint using DTO classes.
+     */
+    static dto: (dto: RSDtoType | typeof BaseDto, optionalParams?: Array<string>, omitParams?: Array<string>, omitResponse?: Array<string>) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `errors` option to the endpoint.
+     */
+    static errors: (errors: IOptions['errors']) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `description` option to the endpoint.
+     */
+    static description: (description: string) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `hideDocs` option to `true` to the endpoint.
+     */
+    static hideDocs: (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `args` option to the endpoint.
+     */
+    static args: (args: Array<Field> | typeof ArgsDto) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `requireApiKey` option to the endpoint.
+     */
+    static requireApiKey: (requireApiKey: boolean) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `excludedApiKey` option to the endpoint.
+     */
+    static excludedApiKeys: (excludedApiKeys: (() => Promise<Array<string>>) | Array<string>) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `timeout` option to the endpoint.
+     */
+    static timeout: (timeout: number) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `props` option to the endpoint.
+     */
+    static props: <IProps = {
+        [key: string]: any;
+    }>(props: IProps) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the endpoint as empty. It returns 204 status code.
+     */
+    static emptyResponse: (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the endpoint as deprecated.
+     */
+    static deprecated: (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    static redirect: (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+}
+export default class Controller {
+    /**
+     * Sets the version to the `Controller` class. All endpoints will have this version.
+     */
+    static version: (version: number) => (target: typeof Controller) => void;
+    /**
+     * @alias version
+     */
+    static v: (version: number) => (target: typeof Controller) => void;
+    static controllerOptions: (options: Partial<import("./decorators/controller-options").IOptions<{
+        [key: string]: any;
+    }>>) => (target: typeof Controller) => void;
+    static resource: (resource: string) => (target: typeof Controller) => void;
+    static Endpoint: typeof E;
+    /**
+     * Marks the endpoint on the method as deprecated.
+     * @deprecated
+     */
+    static deprecated: (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * The endpoint is executed with `PUT` method.
+     * @deprecated
+     */
+    static put: (endpoint: string) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * The endpoint is executed with `GET` method.
+     * @deprecated
+     */
+    static get: (endpoint: string) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * The endpoint is executed with `POST` method.
+     * @deprecated
+     */
+    static post: (endpoint: string) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * The endpoint is executed with `DELETE` method.
+     * @deprecated
+     */
+    static delete: (endpoint: string) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Defines options to the endpoint.
+     * @deprecated
+     */
+    static options: (options: Partial<IOptions<{
+        [key: string]: any;
+    }>>) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Define specific option to the endpoint.
+     * @deprecated
+     */
+    static option: <K extends keyof IOptions<{
+        [key: string]: any;
+    }>>(option: K, value: IOptions<{
+        [key: string]: any;
+    }>[K]) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `auth` option of the endpoint.
+     * @deprecated
+     */
+    static auth: (auth: RouteAuth) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `params` option to the endpoint using DTO classes.
+     * @deprecated
+     */
+    static params: (params: RSDtoType | typeof BaseDto | typeof RequestDto, optionalParams?: Array<string>, omit?: Array<string>) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `response` option to the endpoint using DTO classes.
+     * @deprecated
+     */
+    static response: (response: RSDtoType | typeof BaseDto | typeof ResponseDto | Response.Base, omit?: Array<string>) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `params` and `response` options to the endpoint using DTO classes.
+     * @deprecated
+     */
+    static dto: (dto: RSDtoType | typeof BaseDto, optionalParams?: Array<string>, omitParams?: Array<string>, omitResponse?: Array<string>) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `errors` option to the endpoint.
+     * @deprecated
+     */
+    static errors: (errors: IOptions['errors']) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `description` option to the endpoint.
+     * @deprecated
+     */
+    static description: (description: string) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `hideDocs` option to `true` to the endpoint.
+     * @deprecated
+     */
+    static hideDocs: (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `args` option to the endpoint.
+     * @deprecated
+     */
+    static args: (args: Array<Field> | typeof ArgsDto) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `requireApiKey` option to the endpoint.
+     * @deprecated
+     */
+    static requireApiKey: (requireApiKey: boolean) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `excludedApiKey` option to the endpoint.
+     * @deprecated
+     */
+    static excludedApiKeys: (excludedApiKeys: (() => Promise<Array<string>>) | Array<string>) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `timeout` option to the endpoint.
+     * @deprecated
+     */
+    static timeout: (timeout: number) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the `props` option to the endpoint.
+     * @deprecated
+     */
+    static props: <IProps = {
+        [key: string]: any;
+    }>(props: IProps) => (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    /**
+     * Sets the endpoint as empty. It returns 204 status code.
+     * @deprecated
+     */
+    static emptyResponse: (target: Controller, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+    private static _controllers;
+    /**
+     * Registers all found controllers in the directory to the application.
+     *
+     * @param app The instance of the application.
+     * @param directory Path to the directory where the controllers are located.
+     */
+    static registerDirectory(app: Application, directory: string): Promise<void>;
+    static register(app: Application): void;
+    static getControllers(): Controller[];
+    private _app;
+    constructor(app: Application);
+    register(): void;
+    beforeExecution(req: IRequest, res: IResponse): Promise<void>;
+    getEndpoints(): Array<IEndpoint>;
+    getVersion(): number;
+    getResource(): string;
+    getOptions(propertyKey: string): IRouteOptions;
+    isDeprecated(propertyKey: string): boolean;
+    getRoute(route: string): string;
+    private _getParamsArray;
+    private _getResponseArray;
+}
+export {};