tspace-spear 1.2.1-beta.1 → 1.2.2

package/dist/lib/core/decorators/middleware.d.ts

@@ -0,0 +1,39 @@
+import { T } from '../types';
+/**
+ * Attaches a middleware function to a controller method.
+ *
+ * The middleware will be executed **before the route handler**.
+ * If the middleware calls `next(err)`, the error will be forwarded
+ * to the framework's error handler. Otherwise, the original
+ * controller method will be executed.
+ *
+ * This decorator also stores middleware metadata using `Reflect.defineMetadata`
+ * so the framework can discover and execute it during the request lifecycle.
+ *
+ * @example
+ * ```ts
+ * class UserController {
+ *
+ *   \@Middleware(authMiddleware)
+ *   async profile(ctx: T.Context) {
+ *     return { user: ctx.user };
+ *   }
+ *
+ * }
+ * ```
+ *
+ * Example middleware:
+ *
+ * ```ts
+ * const authMiddleware: T.RequestFunction = (ctx, next) => {
+ *   if (!ctx.user) {
+ *     return next(new Error("Unauthorized"));
+ *   }
+ *   next();
+ * };
+ * ```
+ *
+ * @param {T.RequestFunction} middleware - Middleware function to execute before the route handler.
+ * @returns {MethodDecorator}
+ */
+export declare const Middleware: (middleware: T.RequestFunction) => Function;

package/dist/lib/core/decorators/middleware.js

@@ -1,6 +1,43 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Middleware = void 0;
+/**
+ * Attaches a middleware function to a controller method.
+ *
+ * The middleware will be executed **before the route handler**.
+ * If the middleware calls `next(err)`, the error will be forwarded
+ * to the framework's error handler. Otherwise, the original
+ * controller method will be executed.
+ *
+ * This decorator also stores middleware metadata using `Reflect.defineMetadata`
+ * so the framework can discover and execute it during the request lifecycle.
+ *
+ * @example
+ * ```ts
+ * class UserController {
+ *
+ *   \@Middleware(authMiddleware)
+ *   async profile(ctx: T.Context) {
+ *     return { user: ctx.user };
+ *   }
+ *
+ * }
+ * ```
+ *
+ * Example middleware:
+ *
+ * ```ts
+ * const authMiddleware: T.RequestFunction = (ctx, next) => {
+ *   if (!ctx.user) {
+ *     return next(new Error("Unauthorized"));
+ *   }
+ *   next();
+ * };
+ * ```
+ *
+ * @param {T.RequestFunction} middleware - Middleware function to execute before the route handler.
+ * @returns {MethodDecorator}
+ */
 const Middleware = (middleware) => {
     return (target, key, descriptor) => {
         const originalMethod = descriptor.value;

package/dist/lib/core/decorators/middleware.js.map

@@ -1 +1 @@
-{"version":3,"file":"middleware.js","sourceRoot":"","sources":["../../../../src/lib/core/decorators/middleware.ts"],"names":[],"mappings":";;;AAEO,MAAM,UAAU,GAAG,CAAC,UAA8B,EAAY,EAAE;IAErE,OAAO,CAAC,MAAW,EAAE,GAAW,EAAE,UAA8B,EAAE,EAAE;QAClE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QACxC,UAAU,CAAC,KAAK,GAAG,UAAS,GAAe,EAAG,IAAqB;YACjE,IAAI;gBAEF,OAAO,CAAC,cAAc,CAAC,aAAa,EAAE,UAAU,EAAG,MAAM,CAAC,CAAA;gBAE1D,OAAO,UAAU,CAAC,GAAG,EAAE,CAAC,GAAU,EAAE,EAAE;oBACpC,IAAG,GAAG,IAAI,IAAI,EAAE;wBACd,OAAO,IAAI,CAAC,GAAG,CAAC,CAAA;qBACjB;oBACD,OAAO,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAG,IAAI,CAAC,CAAC;gBAC/C,CAAC,CAAC,CAAA;aAEH;YAAC,OAAO,KAAW,EAAE;gBAEpB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA;aACnB;QACH,CAAC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC,CAAA;AAtBY,QAAA,UAAU,cAsBtB"}
+{"version":3,"file":"middleware.js","sourceRoot":"","sources":["../../../../src/lib/core/decorators/middleware.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACI,MAAM,UAAU,GAAG,CAAC,UAA6B,EAAY,EAAE;IAEpE,OAAO,CAAC,MAAW,EAAE,GAAW,EAAE,UAA8B,EAAE,EAAE;QAClE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAU,GAAc,EAAE,IAAoB;YAC/D,IAAI,CAAC;gBAEH,OAAO,CAAC,cAAc,CAAC,aAAa,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;gBAE1D,OAAO,UAAU,CAAC,GAAG,EAAE,CAAC,GAAS,EAAE,EAAE;oBACnC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;wBAChB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;oBACnB,CAAC;oBAED,OAAO,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;gBAC9C,CAAC,CAAC,CAAC;YAEL,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC;QACH,CAAC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC,CAAC;AAvBW,QAAA,UAAU,cAuBrB"}

package/dist/lib/core/decorators/statusCode.d.ts

@@ -0,0 +1,26 @@
+import { type T } from '../types';
+/**
+ * Sets the HTTP response status code before executing the controller method.
+ *
+ * The provided status code will be automatically clamped between **100** and **599**
+ * to ensure a valid HTTP status range. It also sets the default
+ * `Content-Type` header to `application/json`.
+ *
+ * @example
+ * ```ts
+ * class UserController {
+ *   \@StatusCode(201)
+ *   async create(ctx: T.Context) {
+ *     return { success: true };
+ *   }
+ * }
+ * ```
+ *
+ * In this example the response will be sent with:
+ * - Status: **201 Created**
+ * - Header: `Content-Type: application/json`
+ *
+ * @param {T.StatusCode} statusCode - HTTP status code to send with the response.
+ * @returns {MethodDecorator}
+ */
+export declare const StatusCode: (statusCode: T.StatusCode) => Function;

package/dist/lib/core/decorators/statusCode.js

@@ -1,6 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StatusCode = void 0;
+/**
+ * Sets the HTTP response status code before executing the controller method.
+ *
+ * The provided status code will be automatically clamped between **100** and **599**
+ * to ensure a valid HTTP status range. It also sets the default
+ * `Content-Type` header to `application/json`.
+ *
+ * @example
+ * ```ts
+ * class UserController {
+ *   \@StatusCode(201)
+ *   async create(ctx: T.Context) {
+ *     return { success: true };
+ *   }
+ * }
+ * ```
+ *
+ * In this example the response will be sent with:
+ * - Status: **201 Created**
+ * - Header: `Content-Type: application/json`
+ *
+ * @param {T.StatusCode} statusCode - HTTP status code to send with the response.
+ * @returns {MethodDecorator}
+ */
 const StatusCode = (statusCode) => {
     return (target, key, descriptor) => {
         const originalMethod = descriptor.value;

package/dist/lib/core/decorators/statusCode.js.map

@@ -1 +1 @@
-{"version":3,"file":"statusCode.js","sourceRoot":"","sources":["../../../../src/lib/core/decorators/statusCode.ts"],"names":[],"mappings":";;;AAEO,MAAO,UAAU,GAAG,CAAC,UAAmB,EAAY,EAAE;IACzD,OAAO,CAAC,MAAW,EAAE,GAAW,EAAE,UAA8B,EAAE,EAAE;QAChE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,MAAM,IAAI,GAAG,UAAU,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC;QAE1E,UAAU,CAAC,KAAK,GAAG,KAAK,WAAU,GAAe,EAAG,IAAoB;YACpE,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAG,EAAE,cAAc,EAAE,kBAAkB,EAAC,CAAC,CAAA;YAC/D,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAG,IAAI,CAAC,CAAC;QACvD,CAAC,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAA;AAba,QAAA,UAAU,cAavB"}
+{"version":3,"file":"statusCode.js","sourceRoot":"","sources":["../../../../src/lib/core/decorators/statusCode.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACI,MAAM,UAAU,GAAG,CAAC,UAAwB,EAAY,EAAE;IAC7D,OAAO,CAAC,MAAW,EAAE,GAAW,EAAE,UAA8B,EAAE,EAAE;QAChE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,MAAM,IAAI,GAAG,UAAU,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC;QAE1E,UAAU,CAAC,KAAK,GAAG,KAAK,WAAW,GAAc,EAAE,IAAoB;YACnE,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC,CAAC;YAChE,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QACtD,CAAC,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAC;AAbW,QAAA,UAAU,cAarB"}

package/dist/lib/core/decorators/swagger.d.ts

@@ -0,0 +1,36 @@
+import { type T } from "../types";
+/**
+ * Attaches Swagger/OpenAPI specification metadata to a controller method.
+ *
+ * This decorator stores route documentation using `Reflect.defineMetadata`
+ * so the framework can later collect it and generate **Swagger / OpenAPI**
+ * documentation automatically.
+ *
+ * The metadata is stored on the controller constructor under the key `"swaggers"`.
+ * Each decorated method contributes a Swagger specification object.
+ *
+ * @example
+ * ```ts
+ * class UserController {
+ *
+ *   \@Swagger({
+ *     summary: "Get user profile",
+ *     description: "Returns the authenticated user's profile",
+ *     tags: ["Users"],
+ *     responses: {
+ *       200: {
+ *         description: "Successful response"
+ *       }
+ *     }
+ *   })
+ *   async profile(ctx: T.Context) {
+ *     return { id: 1, name: "John" };
+ *   }
+ *
+ * }
+ * ```
+ *
+ * @param {T.Swagger.Spec} data - Swagger/OpenAPI specification for the route.
+ * @returns {MethodDecorator}
+ */
+export declare const Swagger: (data: T.Swagger.Spec) => (target: any, propertyKey: any) => void;

package/dist/lib/core/decorators/swagger.js

@@ -1,6 +1,40 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Swagger = void 0;
+/**
+ * Attaches Swagger/OpenAPI specification metadata to a controller method.
+ *
+ * This decorator stores route documentation using `Reflect.defineMetadata`
+ * so the framework can later collect it and generate **Swagger / OpenAPI**
+ * documentation automatically.
+ *
+ * The metadata is stored on the controller constructor under the key `"swaggers"`.
+ * Each decorated method contributes a Swagger specification object.
+ *
+ * @example
+ * ```ts
+ * class UserController {
+ *
+ *   \@Swagger({
+ *     summary: "Get user profile",
+ *     description: "Returns the authenticated user's profile",
+ *     tags: ["Users"],
+ *     responses: {
+ *       200: {
+ *         description: "Successful response"
+ *       }
+ *     }
+ *   })
+ *   async profile(ctx: T.Context) {
+ *     return { id: 1, name: "John" };
+ *   }
+ *
+ * }
+ * ```
+ *
+ * @param {T.Swagger.Spec} data - Swagger/OpenAPI specification for the route.
+ * @returns {MethodDecorator}
+ */
 const Swagger = (data) => {
     return (target, propertyKey) => {
         const controller = target.constructor;
@@ -9,7 +43,7 @@ const Swagger = (data) => {
             : [];
         swaggers.push({
             handler: propertyKey,
-            ...data
+            ...data,
         });
         Reflect.defineMetadata("swaggers", swaggers, controller);
     };

package/dist/lib/core/decorators/swagger.js.map

@@ -1 +1 @@
-{"version":3,"file":"swagger.js","sourceRoot":"","sources":["../../../../src/lib/core/decorators/swagger.ts"],"names":[],"mappings":";;;AAEO,MAAM,OAAO,GAAG,CAAC,IAAqB,EAAE,EAAE;IAC7C,OAAO,CAAC,MAAW,EAAE,WAAgB,EAAE,EAAE;QACrC,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC;QAEtC,MAAM,QAAQ,GAAU,OAAO,CAAC,WAAW,CAAC,UAAU,EAAE,UAAU,CAAC;YACnE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,EAAE,UAAU,CAAC;YAC7C,CAAC,CAAC,EAAE,CAAC;QAEL,QAAQ,CAAC,IAAI,CAAC;YACV,OAAO,EAAE,WAAW;YACpB,GAAG,IAAI;SACV,CAAC,CAAC;QAEH,OAAO,CAAC,cAAc,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;IAC3D,CAAC,CAAA;AACL,CAAC,CAAA;AAfU,QAAA,OAAO,WAejB"}
+{"version":3,"file":"swagger.js","sourceRoot":"","sources":["../../../../src/lib/core/decorators/swagger.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACI,MAAM,OAAO,GAAG,CAAC,IAAoB,EAAE,EAAE;IAC9C,OAAO,CAAC,MAAW,EAAE,WAAgB,EAAE,EAAE;QACvC,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC;QAEtC,MAAM,QAAQ,GAAU,OAAO,CAAC,WAAW,CAAC,UAAU,EAAE,UAAU,CAAC;YACjE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,EAAE,UAAU,CAAC;YAC7C,CAAC,CAAC,EAAE,CAAC;QAEP,QAAQ,CAAC,IAAI,CAAC;YACZ,OAAO,EAAE,WAAW;YACpB,GAAG,IAAI;SACR,CAAC,CAAC;QAEH,OAAO,CAAC,cAAc,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;IAC3D,CAAC,CAAC;AACJ,CAAC,CAAC;AAfW,QAAA,OAAO,WAelB"}

package/dist/lib/core/server/index.d.ts

@@ -0,0 +1,292 @@
+import { Server } from 'http';
+import findMyWayRouter, { type Instance } from 'find-my-way';
+import WebSocket from 'ws';
+import { Router } from './router';
+import type { T } from '../types';
+/**
+ *
+ * The 'Spear' class is used to create a server and handle HTTP requests.
+ *
+ * @returns {Spear} application
+ * @example
+ * new Spear()
+ *  .get('/' , () => 'Hello world!')
+ *  .get('/json' , () => {
+ *     return {
+ *       message : 'Hello world!'
+ *     }
+ *   })
+ *  .listen(3000 , () => console.log('server listening on port : 3000'))
+ *
+ */
+declare class Spear {
+    private readonly _controllers?;
+    private readonly _middlewares?;
+    private readonly _globalPrefix;
+    private readonly _router;
+    private readonly _parser;
+    private _cluster?;
+    private _cors?;
+    private _swagger;
+    private _swaggerSpecs;
+    private _wss?;
+    private _ws?;
+    private _wsOptions?;
+    private _errorHandler;
+    private _globalMiddlewares;
+    private _formatResponse;
+    private _onListeners;
+    private _fileUploadOptions;
+    constructor({ controllers, middlewares, globalPrefix, logger, cluster }?: T.Application);
+    /**
+     * The get 'instance' method is used to get the instance of Spear.
+     *
+     * @returns {this}
+     */
+    get instance(): this;
+    /**
+     * The get 'routers' method is used get the all routers.
+     *
+     * @returns {Instance<findMyWayRouter.HTTPVersion.V1>}
+     */
+    get routers(): Instance<findMyWayRouter.HTTPVersion.V1>;
+    /**
+     * The 'ws' method is used to creates the WebSocket server.
+     *
+     * @callback {Function} WebSocketServer
+     * @param {WebSocketServer} wss - WebSocketServer
+     * @returns {this}
+     */
+    ws(handlers: () => T.WebSocketHandler, options?: WebSocket.ServerOptions): this;
+    /**
+     * The 'use' method is used to add the middleware into the request pipeline.
+     *
+     * @callback {Function} middleware
+     * @property  {Object} ctx - context { req , res , query , params , cookies , files , body}
+     * @property  {Function} next  - go to next function
+     * @returns {this}
+     */
+    use(middleware: (ctx: T.Context, next: T.NextFunction) => void): this;
+    /**
+     * The 'useCluster' method is used cluster run the server
+     *
+     * @param {boolean | number} cluster
+     * @returns {this}
+     */
+    useCluster(cluster?: number | boolean): this;
+    /**
+     * The 'useLogger' method is used to add the middleware view logger response.
+     *
+     * @callback {Function} middleware
+     * @property  {Object} ctx - context { req , res , query , params , cookies , files , body}
+     * @property  {Function} next  - go to next function
+     * @returns {this}
+     */
+    useLogger({ methods, exceptPath }?: {
+        methods?: T.MethodInput[];
+        exceptPath?: string[] | RegExp;
+    }): this;
+    /**
+     * The 'useBodyParser' method is a middleware used to parse the request body of incoming HTTP requests.
+     * @param {object?}
+     * @property {array?} except the body parser with some methods
+     * @returns {this}
+     */
+    useBodyParser({ except }?: {
+        except?: T.MethodInput[];
+    }): this;
+    /**
+     * The 'useFileUpload' method is a middleware used to handler file uploads. It adds a file upload of incoming HTTP requests.
+     *
+     * @param {?Object}
+     * @property {?number} limits
+     * @property {?string} tempFileDir
+     * @property {?Object} removeTempFile
+     * @property {boolean} removeTempFile.remove
+     * @property {number} removeTempFile.ms
+     * @returns
+     */
+    useFileUpload({ limit, tempFileDir, removeTempFile }?: {
+        limit?: number;
+        tempFileDir?: string;
+        removeTempFile?: {
+            remove: boolean;
+            ms: number;
+        };
+    }): this;
+    /**
+     * The 'useCookiesParser' method is a middleware used to parses cookies attached to the client request object.
+     *
+     * @returns {this}
+     */
+    useCookiesParser(): this;
+    /**
+     * The 'useRouter' method is used to add the router in the request context.
+     *
+     * @parms {Function} router
+     * @property  {Function} router - get() , post() , put() , patch() , delete()
+     * @returns {this}
+     */
+    useRouter(router: Router): this;
+    /**
+     * The 'useSwagger' method is a middleware used to create swagger api.
+     *
+     * @param {?Object} doc
+     * @returns
+     */
+    useSwagger(doc?: T.Swagger.Doc): this;
+    /**
+     * The 'listen' method is used to bind and start a server to a particular port and optionally a hostname.
+     *
+     * @param {number} port
+     * @param {function} callback
+     * @returns
+     */
+    listen(port: number, hostname?: string | ((callback: {
+        server: Server;
+        port: number;
+    }) => void), callback?: (callback: {
+        server: Server;
+        port: number;
+    }) => void): Promise<Server>;
+    /**
+     * The 'cors' is used to enable the cors origins on the server.
+     *
+     * @params {Object}
+     * @property {(string | RegExp)[]} origins
+     * @property {boolean} credentials
+     * @returns
+     */
+    cors({ origins, credentials }?: {
+        origins?: (string | RegExp)[];
+        credentials?: boolean;
+    }): this;
+    /**
+     * The 'response' method is used to format the response
+     *
+     * @param {function} format
+     * @returns
+     */
+    response(format: (r: unknown, statusCode: number) => any): this;
+    /**
+     * The 'catch' method is middleware that is specifically designed to handle errors.
+     *
+     * that occur during the processing of requests
+     *
+     * @param {function} error
+     * @returns
+     */
+    catch(error: (err: any, ctx: T.Context) => any): this;
+    /**
+     * The 'notfound' method is middleware that is specifically designed to handle errors notfound that occur during the processing of requests
+     *
+     * @param {function} fn
+     * @returns
+     */
+    notfound(fn: (ctx: T.Context) => any): this;
+    /**
+     * The 'get' method is used to add the request handler to the router for the 'GET' method.
+     *
+     * @param {string} path
+     * @callback {...Function[]} handlers of the middlewares
+     * @property  {Object} ctx - context { req , res , query , params , cookies , files , body}
+     * @property  {Function} next  - go to next function
+     * @returns {this}
+     */
+    get(path: string, ...handlers: ((ctx: T.Context, next: T.NextFunction) => any)[]): this;
+    /**
+     * The 'post' method is used to add the request handler to the router for the 'POST' method.
+     *
+     * @param {string} path
+     * @callback {...Function[]} handlers of the middlewares
+     * @property  {Object} ctx - context { req , res , query , params , cookies , files , body}
+     * @property  {Function} next  - go to next function
+     * @returns {this}
+     */
+    post(path: string, ...handlers: ((ctx: T.Context, next: T.NextFunction) => any)[]): this;
+    /**
+     * The 'put' method is used to add the request handler to the router for the 'PUT' method.
+     *
+     * @param {string} path
+     * @callback {...Function[]} handlers of the middlewares
+     * @property  {Object} ctx - context { req , res , query , params , cookies , files , body}
+     * @property  {Function} next  - go to next function
+     * @returns {this}
+     */
+    put(path: string, ...handlers: ((ctx: T.Context, next: T.NextFunction) => any)[]): this;
+    /**
+     * The 'patch' method is used to add the request handler to the router for the 'PATCH' method.
+     *
+     * @param {string} path
+     * @callback {...Function[]} handlers of the middlewares
+     * @property  {Object} ctx - context { req , res , query , params , cookies , files , body}
+     * @property  {Function} next  - go to next function
+     * @returns {this}
+     */
+    patch(path: string, ...handlers: ((ctx: T.Context, next: T.NextFunction) => any)[]): this;
+    /**
+     * The 'delete' method is used to add the request handler to the router for the 'DELETE' method.
+     *
+     * @param {string} path
+     * @callback {...Function[]} handlers of the middlewares
+     * @property  {Object} ctx - context { req , res , query , params , cookies , files , body}
+     * @property  {Function} next  - go to next function
+     * @returns {this}
+     */
+    delete(path: string, ...handlers: ((ctx: T.Context, next: T.NextFunction) => any)[]): this;
+    /**
+     * The 'head' method is used to add the request handler to the router for 'HEAD' methods.
+     *
+     * @param {string} path
+     * @callback {...Function[]} handlers of the middlewares
+     * @property  {object} ctx - context { req , res , query , params , cookies , files , body}
+     * @property  {function} next  - go to next function
+     * @returns {this}
+     */
+    head(path: string, ...handlers: ((ctx: T.Context, next: T.NextFunction) => any)[]): this;
+    /**
+     * The 'head' method is used to add the request handler to the router for 'HEAD' methods.
+     *
+     * @param {string} path
+     * @callback {...Function[]} handlers of the middlewares
+     * @property  {object} ctx - context { req , res , query , params , cookies , files , body}
+     * @property  {function} next  - go to next function
+     * @returns {this}
+     */
+    options(path: string, ...handlers: ((ctx: T.Context, next: T.NextFunction) => any)[]): this;
+    /**
+     * The 'any' method is used to add the request handler to the router for 'GET' 'POST' 'PUT' 'PATCH' 'DELETE' 'HEAD' 'OPTIONS' methods.
+     *
+     * @param {string} path
+     * @callback {...Function[]} handlers of the middlewares
+     * @property  {object} ctx - context { req , res , query , params , cookies , files , body}
+     * @property  {function} next  - go to next function
+     * @returns {this}
+     */
+    any(path: string, ...handlers: ((ctx: T.Context, next: T.NextFunction) => any)[]): this;
+    /**
+    * The 'all' method is used to add the request handler to the router for 'GET' 'POST' 'PUT' 'PATCH' 'DELETE' 'HEAD' 'OPTIONS' methods.
+    *
+    * @param {string} path
+    * @callback {...Function[]} handlers of the middlewares
+    * @property  {object} ctx - context { req , res , query , params , cookies , files , body}
+    * @property  {function} next  - go to next function
+    * @returns {this}
+    */
+    all(path: string, ...handlers: ((ctx: T.Context, next: T.NextFunction) => any)[]): this;
+    private _clusterMode;
+    private _import;
+    private _registerControllers;
+    private _registerMiddlewares;
+    private _customizeResponse;
+    private _wrapHandlers;
+    private _wrapResponse;
+    private _nextFunction;
+    private _createServer;
+    private _normalizePath;
+    private _swaggerHandler;
+}
+export declare class Application extends Spear {
+}
+export { Spear };
+export default Spear;