tspace-spear 1.0.1 → 1.0.2

package/README.md

@@ -3,7 +3,8 @@
 [![NPM version](https://img.shields.io/npm/v/tspace-spear.svg)](https://www.npmjs.com)
 [![NPM downloads](https://img.shields.io/npm/dm/tspace-spear.svg)](https://www.npmjs.com)
 
-tspace-spear is a lightweight API framework for Node.js that is fast and highly focused on providing the best developer experience. It utilizes the native HTTP server.
+tspace-spear is a lightweight API framework for Node.js that is fast and highly focused on providing the best developer experience. 
+It utilizes the native HTTP server.
 
 ## Install
 
@@ -16,6 +17,7 @@ npm install tspace-spear --save
 ## Basic Usage
 - [StartServer](#start-server)
   - [CRUD](#crud)
+  - [Cluster](#cluster)
 - [Middleware](#middleware)
 - [Controller](#controller)
 - [Router](#router)
@@ -103,6 +105,27 @@ new Spear()
 )
 ```
 
+## Cluster
+```js
+import Spear from "tspace-spear";
+new Spear({
+  cluster : {
+    use : true,
+    maxWorkers : 3
+  }
+})
+.get('/' , () => 'Hello world!')
+.get('/json' , () => {
+  return {
+    message : 'Hello world!'
+  }
+})
+.listen(3000 , ({ server, port }) => 
+  console.log(`server listening on : http://localhost:${port}`)
+)
+
+```
+
 ## Middleware
 ```js
 // file cat-middleware.ts
@@ -511,6 +534,11 @@ const app = new Spear({
   logger : true, // logging
   globalPrefix : '/api' // prefix all routes
 })
+// or use this for logging
+app.useLogger({
+    methods     : ['GET','POST'],
+    exceptPath  : ['/']
+})
 
 app.enableCors({
     origins: [

package/build/lib/core/decorators/context.js

@@ -82,7 +82,7 @@ const Cookies = (...cookiesParms) => {
                 var _a;
                 const q = (_a = ctx === null || ctx === void 0 ? void 0 : ctx.cookies) !== null && _a !== void 0 ? _a : {};
                 const cookies = cookiesParms.reduce((acc, key) => (q[key] != null ? Object.assign(Object.assign({}, acc), { [key]: q[key] }) : acc), {});
-                ctx.cookies = Object.keys(cookies).length ? cookies : null;
+                ctx.cookies = Object.keys(cookies).length ? cookies : {};
                 return yield originalMethod.call(this, ctx, next);
             });
         };

package/build/lib/core/decorators/context.js.map

@@ -1 +1 @@
-{"version":3,"file":"context.js","sourceRoot":"","sources":["../../../../src/lib/core/decorators/context.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEO,MAAM,IAAI,GAAG,CAAC,GAAG,SAAoB,EAAE,EAAE;IAC5C,OAAO,UAAS,MAAW,EAAE,GAAW,EAAE,UAA8B;QACpE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAe,GAAc,EAAG,IAAmB;;;gBAClE,MAAM,CAAC,GAAG,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,mCAAI,EAAE,CAAA;gBACzB,MAAM,IAAI,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,iCAAM,GAAG,KAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAG,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAA;gBACnG,GAAG,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAA;gBAE/C,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAG,IAAI,CAAC,CAAC;YACvD,CAAC;SAAA,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAA;AAdY,QAAA,IAAI,QAchB;AAEM,MAAM,KAAK,GAAG,CAAC,GAAG,UAAqB,EAAE,EAAE;IAC9C,OAAO,UAAS,MAAW,EAAE,GAAW,EAAE,UAA8B;QACpE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAe,GAAc,EAAG,IAAmB;;;gBAClE,MAAM,CAAC,GAAG,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,mCAAI,EAAE,CAAA;gBAC1B,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,iCAAM,GAAG,KAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAG,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAA;gBACrG,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAA;gBAElD,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAG,IAAI,CAAC,CAAC;YACvD,CAAC;SAAA,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAA;AAdY,QAAA,KAAK,SAcjB;AAEM,MAAM,MAAM,GAAG,CAAC,GAAG,UAAqB,EAAE,EAAE;IAC/C,OAAO,UAAS,MAAW,EAAE,GAAW,EAAE,UAA8B;QACpE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAe,GAAc,EAAG,IAAmB;;;gBAClE,MAAM,CAAC,GAAG,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,MAAM,mCAAI,EAAE,CAAA;gBAC3B,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,iCAAM,GAAG,KAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAG,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAA;gBACtG,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAA;gBAErD,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAG,IAAI,CAAC,CAAC;YACvD,CAAC;SAAA,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAA;AAdY,QAAA,MAAM,UAclB;AAEM,MAAM,KAAK,GAAG,CAAC,GAAG,UAAqB,EAAE,EAAE;IAC9C,OAAO,UAAS,MAAW,EAAE,GAAW,EAAE,UAA8B;QACpE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAe,GAAc,EAAG,IAAmB;;;gBAClE,MAAM,CAAC,GAAG,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,mCAAI,EAAE,CAAA;gBAC1B,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,iCAAM,GAAG,KAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAG,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAA;gBACrG,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAA;gBAElD,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAG,IAAI,CAAC,CAAC;YACvD,CAAC;SAAA,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAA;AAdY,QAAA,KAAK,SAcjB;AAGM,MAAM,OAAO,GAAG,CAAC,GAAG,YAAuB,EAAE,EAAE;IAClD,OAAO,UAAS,MAAW,EAAE,GAAW,EAAE,UAA8B;QACpE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAe,GAAc,EAAG,IAAmB;;;gBAClE,MAAM,CAAC,GAAG,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,mCAAI,EAAE,CAAA;gBAC5B,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,iCAAM,GAAG,KAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAG,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAA;gBACzG,GAAG,CAAC,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAA;gBAE1D,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAG,IAAI,CAAC,CAAC;YACvD,CAAC;SAAA,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAA;AAdY,QAAA,OAAO,WAcnB"}
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../../../src/lib/core/decorators/context.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEO,MAAM,IAAI,GAAG,CAAC,GAAG,SAAoB,EAAE,EAAE;IAC5C,OAAO,UAAS,MAAW,EAAE,GAAW,EAAE,UAA8B;QACpE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAe,GAAc,EAAG,IAAmB;;;gBAClE,MAAM,CAAC,GAAG,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,mCAAI,EAAE,CAAA;gBACzB,MAAM,IAAI,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,iCAAM,GAAG,KAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAG,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAA;gBACnG,GAAG,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAA;gBAE/C,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAG,IAAI,CAAC,CAAC;YACvD,CAAC;SAAA,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAA;AAdY,QAAA,IAAI,QAchB;AAEM,MAAM,KAAK,GAAG,CAAC,GAAG,UAAqB,EAAE,EAAE;IAC9C,OAAO,UAAS,MAAW,EAAE,GAAW,EAAE,UAA8B;QACpE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAe,GAAc,EAAG,IAAmB;;;gBAClE,MAAM,CAAC,GAAG,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,mCAAI,EAAE,CAAA;gBAC1B,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,iCAAM,GAAG,KAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAG,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAA;gBACrG,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAA;gBAElD,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAG,IAAI,CAAC,CAAC;YACvD,CAAC;SAAA,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAA;AAdY,QAAA,KAAK,SAcjB;AAEM,MAAM,MAAM,GAAG,CAAC,GAAG,UAAqB,EAAE,EAAE;IAC/C,OAAO,UAAS,MAAW,EAAE,GAAW,EAAE,UAA8B;QACpE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAe,GAAc,EAAG,IAAmB;;;gBAClE,MAAM,CAAC,GAAG,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,MAAM,mCAAI,EAAE,CAAA;gBAC3B,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,iCAAM,GAAG,KAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAG,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAA;gBACtG,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAA;gBAErD,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAG,IAAI,CAAC,CAAC;YACvD,CAAC;SAAA,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAA;AAdY,QAAA,MAAM,UAclB;AAEM,MAAM,KAAK,GAAG,CAAC,GAAG,UAAqB,EAAE,EAAE;IAC9C,OAAO,UAAS,MAAW,EAAE,GAAW,EAAE,UAA8B;QACpE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAe,GAAc,EAAG,IAAmB;;;gBAClE,MAAM,CAAC,GAAG,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,mCAAI,EAAE,CAAA;gBAC1B,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,iCAAM,GAAG,KAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAG,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAA;gBACrG,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAA;gBAElD,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAG,IAAI,CAAC,CAAC;YACvD,CAAC;SAAA,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAA;AAdY,QAAA,KAAK,SAcjB;AAGM,MAAM,OAAO,GAAG,CAAC,GAAG,YAAuB,EAAE,EAAE;IAClD,OAAO,UAAS,MAAW,EAAE,GAAW,EAAE,UAA8B;QACpE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,UAAe,GAAc,EAAG,IAAmB;;;gBAClE,MAAM,CAAC,GAAG,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,mCAAI,EAAE,CAAA;gBAC5B,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,iCAAM,GAAG,KAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAG,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAA;gBACzG,GAAG,CAAC,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAA;gBAExD,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAG,IAAI,CAAC,CAAC;YACvD,CAAC;SAAA,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAA;AAdY,QAAA,OAAO,WAcnB"}

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

@@ -1,13 +1,14 @@
-import findMyWayRouter from 'find-my-way';
 import { Server, ServerResponse } from 'http';
-import { Router, TContext, TNextFunction, TApplication } from '../..';
+import findMyWayRouter from 'find-my-way';
+import { Router } from './router';
+import type { TContext, TNextFunction, TApplication } from '../types';
 /**
  *
  * The 'Spear' class is used to create a server and handle HTTP requests.
  *
  * @returns {Spear} application
  * @example
- * new Application()
+ * new Spear()
  *  .get('/' , () => 'Hello world!')
  *  .get('/json' , () => {
  *     return {
@@ -21,6 +22,7 @@ declare class Spear {
     private readonly _controllers?;
     private readonly _middlewares?;
     private readonly _globalPrefix;
+    private readonly _cluster?;
     private readonly _router;
     private readonly _parser;
     private _swagger;
@@ -30,30 +32,30 @@ declare class Spear {
     private _formatResponse;
     private _onListeners;
     private _fileUploadOptions;
-    constructor({ controllers, middlewares, globalPrefix, logger }?: TApplication);
+    constructor({ controllers, middlewares, globalPrefix, logger, cluster }?: TApplication);
     get instance(): this;
     get routers(): findMyWayRouter.Instance<findMyWayRouter.HTTPVersion.V1>;
     /**
-     * The 'enableCors' is used to enable the cors origins on the server.
+     * The 'use' method is used to add the middleware into the request pipeline.
      *
-     * @params {Object}
-     * @property {(string | RegExp)[]} origins
-     * @property {boolean} credentials
-     * @returns
+     * @callback {Function} middleware
+     * @property  {Object} ctx - context { req , res , query , params , cookies , files , body}
+     * @property  {Function} next  - go to next function
+     * @returns {this}
      */
-    enableCors({ origins, credentials }?: {
-        origins?: (string | RegExp)[];
-        credentials?: boolean;
-    }): this;
+    use(middleware: (ctx: TContext, next: TNextFunction) => void): this;
     /**
-     * The 'use' method is used to add the middleware into the request pipeline.
+     * 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}
      */
-    use(middleware: (ctx: TContext, next: TNextFunction) => void): this;
+    useLogger({ methods, exceptPath }?: {
+        methods?: ('GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE')[];
+        exceptPath?: string[] | RegExp;
+    }): this;
     /**
      * The 'useBodyParser' method is a middleware used to parse the request body of incoming HTTP requests.
      *
@@ -116,6 +118,29 @@ declare class Spear {
             version?: string;
         };
     }): 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 | (() => ServerResponse)) | undefined, callback: (callback: {
+        server: Server;
+        port: number;
+    }) => void): Promise<void>;
+    /**
+     * The 'enableCors' is used to enable the cors origins on the server.
+     *
+     * @params {Object}
+     * @property {(string | RegExp)[]} origins
+     * @property {boolean} credentials
+     * @returns
+     */
+    enableCors({ origins, credentials }?: {
+        origins?: (string | RegExp)[];
+        credentials?: boolean;
+    }): this;
     /**
      * The 'formatResponse' method is used to format the response
      *
@@ -124,7 +149,9 @@ declare class Spear {
      */
     formatResponse(format: (r: unknown, statusCode: number) => any): this;
     /**
-     * The 'errorHandler' method is middleware that is specifically designed to handle errors that occur during the processing of requests
+     * The 'errorHandler' method is middleware that is specifically designed to handle errors.
+     *
+     * that occur during the processing of requests
      *
      * @param {function} error
      * @returns
@@ -188,7 +215,7 @@ declare class Spear {
      */
     delete(path: string, ...handlers: ((ctx: TContext, next: TNextFunction) => any)[]): this;
     /**
-     * The 'all' method is used to add the request handler to the router for the 'all' method.
+     * The 'all' method is used to add the request handler to the router for 'GET' 'POST' 'PUT' 'PATCH' 'DELETE' methods.
      *
      * @param {string} path
      * @callback {...Function[]} handlers of the middlewares
@@ -197,18 +224,7 @@ declare class Spear {
      * @returns {this}
      */
     all(path: string, ...handlers: ((ctx: TContext, next: TNextFunction) => any)[]): 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} cb
-     * @returns
-     */
-    listen(port: (number | (() => ServerResponse)) | undefined, cb: (callback: {
-        server: Server;
-        port: number;
-    }) => void): Promise<void>;
-    private _logger;
+    private _clusterMode;
     private _import;
     private _registerControllers;
     private _registerMiddlewares;
@@ -218,8 +234,9 @@ declare class Spear {
     private _wrapResponse;
     private _createServer;
     private _normalizePath;
+    private _swaggerHandler;
 }
-export { Spear };
 export declare class Application extends Spear {
 }
+export { Spear };
 export default Spear;

package/build/lib/core/server/index.js

@@ -35,13 +35,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Application = exports.Spear = void 0;
+exports.Spear = exports.Application = void 0;
+const cluster_1 = __importDefault(require("cluster"));
+const os_1 = __importDefault(require("os"));
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
-const find_my_way_1 = __importDefault(require("find-my-way"));
 const url_1 = require("url");
 const on_finished_1 = __importDefault(require("on-finished"));
 const http_1 = __importStar(require("http"));
+const find_my_way_1 = __importDefault(require("find-my-way"));
 const parser_factory_1 = require("./parser-factory");
 /**
  *
@@ -49,7 +51,7 @@ const parser_factory_1 = require("./parser-factory");
  *
  * @returns {Spear} application
  * @example
- * new Application()
+ * new Spear()
  *  .get('/' , () => 'Hello world!')
  *  .get('/json' , () => {
  *     return {
@@ -60,7 +62,7 @@ const parser_factory_1 = require("./parser-factory");
  *
  */
 class Spear {
-    constructor({ controllers, middlewares, globalPrefix, logger } = {}) {
+    constructor({ controllers, middlewares, globalPrefix, logger, cluster } = {}) {
         this._router = (0, find_my_way_1.default)();
         this._parser = new parser_factory_1.ParserFactory();
         this._swagger = {
@@ -140,7 +142,8 @@ class Spear {
             });
         };
         if (logger)
-            this._onListeners.push(() => this.use(this._logger));
+            this.useLogger();
+        this._cluster = cluster;
         this._controllers = controllers;
         this._middlewares = middlewares;
         this._globalPrefix = globalPrefix == null ? '' : globalPrefix;
@@ -152,46 +155,63 @@ class Spear {
         return this._router;
     }
     /**
-     * The 'enableCors' is used to enable the cors origins on the server.
+     * The 'use' method is used to add the middleware into the request pipeline.
      *
-     * @params {Object}
-     * @property {(string | RegExp)[]} origins
-     * @property {boolean} credentials
-     * @returns
+     * @callback {Function} middleware
+     * @property  {Object} ctx - context { req , res , query , params , cookies , files , body}
+     * @property  {Function} next  - go to next function
+     * @returns {this}
      */
-    enableCors({ origins, credentials } = {}) {
-        this._globalMiddlewares.push(({ req, res }, next) => {
-            var _a;
-            const origin = (_a = req.headers) === null || _a === void 0 ? void 0 : _a.origin;
-            if (origin == null)
-                return next();
-            res.setHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, PATCH, DELETE, OPTIONS');
-            res.setHeader('Access-Control-Allow-Headers', 'Content-Type, Authorization');
-            if (origins == null) {
-                res.setHeader('Access-Control-Allow-Origin', '*');
-            }
-            if (Array.isArray(origins) && origins.length) {
-                if (origins.includes(origin)) {
-                    res.setHeader('Access-Control-Allow-Origin', origin);
-                }
-            }
-            if (credentials) {
-                res.setHeader('Access-Control-Allow-Credentials', 'true');
-            }
-            return next();
-        });
+    use(middleware) {
+        this._globalMiddlewares.push(middleware);
         return this;
     }
     /**
-     * The 'use' method is used to add the middleware into the request pipeline.
+     * 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}
      */
-    use(middleware) {
-        this._globalMiddlewares.push(middleware);
+    useLogger({ methods, exceptPath } = {}) {
+        this._globalMiddlewares.push(({ req, res }, next) => {
+            const diffTime = (hrtime) => {
+                const MS = 1000;
+                if (hrtime == null)
+                    return 0;
+                const [start, end] = process.hrtime(hrtime);
+                const time = ((start * MS) + (end / 1e6));
+                return `${time > MS ? `${(time / MS).toFixed(2)} s` : `${time.toFixed(2)} ms`}`;
+            };
+            const statusCode = (res) => {
+                const statusCode = res.statusCode == null ? 500 : Number(res.statusCode);
+                return statusCode < 400
+                    ? `\x1b[32m${statusCode}\x1b[0m`
+                    : `\x1b[31m${statusCode}\x1b[0m`;
+            };
+            if (exceptPath instanceof RegExp && !exceptPath.test(String(req.url)))
+                return next();
+            if (Array.isArray(exceptPath) && !exceptPath.some(v => String(req.url) !== v))
+                return next();
+            if (methods != null &&
+                methods.length &&
+                !methods.some(v => v.toLocaleLowerCase() === String(req.method).toLocaleLowerCase())) {
+                return next();
+            }
+            const startTime = process.hrtime();
+            (0, on_finished_1.default)(res, () => {
+                console.log([
+                    `[\x1b[1m\x1b[34mINFO\x1b[0m]`,
+                    `\x1b[34m${new Date().toJSON()}\x1b[0m`,
+                    `\x1b[33m${req.method}\x1b[0m`,
+                    `${decodeURIComponent(String(req.url))}`,
+                    `${statusCode(res)}`,
+                    `${diffTime(startTime)}`,
+                ].join(" "));
+            });
+            return next();
+        });
         return this;
     }
     /**
@@ -264,10 +284,8 @@ class Spear {
         this._globalMiddlewares.push((_a, next_1) => __awaiter(this, [_a, next_1], void 0, function* ({ req }, next) {
             const contentType = req === null || req === void 0 ? void 0 : req.headers['content-type'];
             const isFileUpload = contentType && contentType.startsWith('multipart/form-data');
-            const isListMethods = ['POST', 'PATCH', 'PUT'].includes(String(req.method));
-            if (!isListMethods)
-                return next();
-            if (!isFileUpload)
+            const isListMethods = ['POST', 'PATCH', 'PUT', 'DELETE'].includes(String(req.method));
+            if (!isListMethods || !isFileUpload)
                 return next();
             if ((req === null || req === void 0 ? void 0 : req._filesParser) != null)
                 return next();
@@ -298,6 +316,74 @@ class Spear {
         };
         return 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() {
+        var arguments_1 = arguments;
+        return __awaiter(this, arguments, void 0, function* (port = 3000, callback) {
+            if (arguments_1.length === 1 && typeof port === 'function') {
+                callback = port;
+                port = 3000;
+            }
+            const server = yield this._createServer();
+            if (this._cluster != null &&
+                this._cluster || (typeof this._cluster === 'object' && Object.keys(this._cluster).length)) {
+                this._clusterMode(server, Number(port), callback);
+                return;
+            }
+            server.listen(port == null ? 3000 : port, () => {
+                if (callback)
+                    callback({ server, port });
+            });
+            server.on('listening', () => {
+                this._onListeners.forEach(listener => listener());
+                if (this._swagger.use) {
+                    this._swaggerHandler();
+                }
+            });
+            server.on('error', (_) => {
+                port = Math.floor(Math.random() * 8999) + 1000;
+                server.listen(port);
+            });
+            return;
+        });
+    }
+    /**
+     * The 'enableCors' is used to enable the cors origins on the server.
+     *
+     * @params {Object}
+     * @property {(string | RegExp)[]} origins
+     * @property {boolean} credentials
+     * @returns
+     */
+    enableCors({ origins, credentials } = {}) {
+        this._globalMiddlewares.push(({ req, res }, next) => {
+            var _a;
+            const origin = (_a = req.headers) === null || _a === void 0 ? void 0 : _a.origin;
+            if (origin == null)
+                return next();
+            res.setHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, PATCH, DELETE, OPTIONS');
+            res.setHeader('Access-Control-Allow-Headers', 'Content-Type, Authorization');
+            if (origins == null) {
+                res.setHeader('Access-Control-Allow-Origin', '*');
+            }
+            if (Array.isArray(origins) && origins.length) {
+                if (origins.includes(origin)) {
+                    res.setHeader('Access-Control-Allow-Origin', origin);
+                }
+            }
+            if (credentials) {
+                res.setHeader('Access-Control-Allow-Credentials', 'true');
+            }
+            return next();
+        });
+        return this;
+    }
     /**
      * The 'formatResponse' method is used to format the response
      *
@@ -309,7 +395,9 @@ class Spear {
         return this;
     }
     /**
-     * The 'errorHandler' method is middleware that is specifically designed to handle errors that occur during the processing of requests
+     * The 'errorHandler' method is middleware that is specifically designed to handle errors.
+     *
+     * that occur during the processing of requests
      *
      * @param {function} error
      * @returns
@@ -418,7 +506,7 @@ class Spear {
         return this;
     }
     /**
-     * The 'all' method is used to add the request handler to the router for the 'all' method.
+     * The 'all' method is used to add the request handler to the router for 'GET' 'POST' 'PUT' 'PATCH' 'DELETE' methods.
      *
      * @param {string} path
      * @callback {...Function[]} handlers of the middlewares
@@ -432,73 +520,40 @@ class Spear {
         });
         return 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} cb
-     * @returns
-     */
-    listen() {
-        var arguments_1 = arguments;
-        return __awaiter(this, arguments, void 0, function* (port = 3000, cb) {
-            if (arguments_1.length === 1 && typeof port === 'function') {
-                cb = port;
-                port = 3000;
+    _clusterMode(server, port, callback) {
+        var _a;
+        if (cluster_1.default.isPrimary) {
+            const numCPUs = os_1.default.cpus().length;
+            const maxWorkers = ((_a = this._cluster) === null || _a === void 0 ? void 0 : _a.maxWorkers) == null
+                ? numCPUs
+                : this._cluster.maxWorkers > numCPUs
+                    ? numCPUs
+                    : this._cluster.maxWorkers;
+            for (let i = 0; i < maxWorkers; i++) {
+                cluster_1.default.fork();
             }
-            const server = yield this._createServer();
+            cluster_1.default.on('exit', () => {
+                cluster_1.default.fork();
+            });
+        }
+        if (cluster_1.default.isWorker) {
             server.listen(port == null ? 3000 : port, () => {
-                if (cb)
-                    cb({ server, port });
+                if (callback) {
+                    callback({ server, port });
+                }
             });
             server.on('listening', () => {
                 this._onListeners.forEach(listener => listener());
                 if (this._swagger.use) {
-                    const routes = this.routers
-                        .routes.filter(r => ["GET", "POST", "PUT", "PATCH", "DELETE"].includes(r.method));
-                    const { path, html, staticSwaggerHandler, staticUrl } = this._parser.swagger(Object.assign(Object.assign({}, this._swagger), { options: this._swaggerAdditional, routes }));
-                    this.routers.get(staticUrl, staticSwaggerHandler);
-                    this.routers.get(String(path), (req, res) => {
-                        res.writeHead(200, { 'Content-Type': 'text/html' });
-                        res.write(html);
-                        return res.end();
-                    });
+                    this._swaggerHandler();
                 }
             });
             server.on('error', (_) => {
                 port = Math.floor(Math.random() * 8999) + 1000;
                 server.listen(port);
             });
-            return;
-        });
-    }
-    _logger({ req, res }, next) {
-        const diffTime = (hrtime) => {
-            const MS = 1000;
-            if (hrtime == null)
-                return 0;
-            const [start, end] = process.hrtime(hrtime);
-            const time = +(((start * MS) + (end / 1e6)).toFixed(2));
-            return `${time > MS ? `${time / MS} s` : `${time} ms`}`;
-        };
-        const statusCode = (res) => {
-            const statusCode = res.statusCode == null ? 500 : Number(res.statusCode);
-            return statusCode < 400
-                ? `\x1b[32m${statusCode}\x1b[0m`
-                : `\x1b[31m${statusCode}\x1b[0m`;
-        };
-        const startTime = process.hrtime();
-        (0, on_finished_1.default)(res, () => {
-            console.log([
-                `[\x1b[1m\x1b[34mINFO\x1b[0m]`,
-                `\x1b[34m${new Date().toJSON()}\x1b[0m`,
-                `\x1b[33m${req.method}\x1b[0m`,
-                `${decodeURIComponent(String(req.url))}`,
-                `${statusCode(res)}`,
-                `${diffTime(startTime)}`,
-            ].join(" "));
-        });
-        return next();
+        }
+        return;
     }
     _import(dir, pattern) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -613,6 +668,10 @@ class Spear {
             res.writeHead(res.statusCode, { 'Content-Type': 'text/plain' });
             return res.end(results);
         };
+        response.html = (results) => {
+            res.writeHead(res.statusCode, { 'Content-Type': 'text/html' });
+            return res.end(results);
+        };
         response.error = (err) => {
             var _a, _b, _c, _d, _e, _f, _g, _h;
             let code = +((_b = (_a = err.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.code) ||
@@ -743,6 +802,7 @@ class Spear {
         return response;
     }
     _nextFunction(ctx) {
+        const NEXT_MESSAGE = "The 'next' function does not have any subsequent function.";
         return (err) => __awaiter(this, void 0, void 0, function* () {
             if (err != null) {
                 if (this._errorHandler != null) {
@@ -759,16 +819,16 @@ class Spear {
                 }, null, 2));
             }
             if (this._errorHandler != null) {
-                return this._errorHandler(new Error(`The 'next' function does not have any subsequent function.`), ctx);
+                return this._errorHandler(new Error(NEXT_MESSAGE), ctx);
             }
             ctx.res.writeHead(500, { 'Content-Type': 'application/json' });
             if (this._formatResponse != null) {
                 return ctx.res.end(JSON.stringify(this._formatResponse({
-                    message: `The 'next' function does not have any subsequent function.`
+                    message: NEXT_MESSAGE
                 }, ctx.res.statusCode), null, 2));
             }
             return ctx.res.end(JSON.stringify({
-                message: `The 'next' function does not have any subsequent function.`
+                message: NEXT_MESSAGE
             }, null, 2));
         });
     }
@@ -815,6 +875,8 @@ class Spear {
             const server = http_1.default.createServer((req, res) => {
                 return this._router.lookup(req, res);
             });
+            server.keepAliveTimeout = 1000 * 120;
+            server.requestTimeout = 1000 * 120;
             return server;
         });
     }
@@ -826,6 +888,18 @@ class Spear {
         const normalizedPath = path.startsWith('/') ? path : `/${path}`;
         return /\/api\/api/.test(normalizedPath) ? normalizedPath.replace(/\/api\/api\//, "/api/") : normalizedPath;
     }
+    _swaggerHandler() {
+        const routes = this.routers
+            .routes.filter(r => ["GET", "POST", "PUT", "PATCH", "DELETE"].includes(r.method));
+        const { path, html, staticSwaggerHandler, staticUrl } = this._parser.swagger(Object.assign(Object.assign({}, this._swagger), { options: this._swaggerAdditional, routes }));
+        this._router.get(staticUrl, staticSwaggerHandler);
+        this._router.get(String(path), (req, res) => {
+            res.writeHead(200, { 'Content-Type': 'text/html' });
+            res.write(html);
+            return res.end();
+        });
+        return;
+    }
 }
 exports.Spear = Spear;
 class Application extends Spear {