tspace-spear 1.2.2 → 1.2.3

package/README.md

@@ -3,8 +3,10 @@
 [![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 and high-performance API framework for Node.js, 
+built on the native HTTP server with optional support for uWebSockets.js (C++) to achieve maximum speed and efficiency. 
+
+It is designed with a strong focus on delivering an excellent developer experience.
 
 ## Install
 
@@ -16,6 +18,7 @@ npm install tspace-spear --save
 ```
 ## Basic Usage
 - [Start Server](#start-server)
+- [Adapter](#adapter)
 - [Cluster](#cluster)
 - [Global Prefix](#global-prefix)
 - [Logger](#logger)
@@ -31,7 +34,7 @@ npm install tspace-spear --save
 - [Controller](#controller)
 - [Router](#router)
 - [Swagger](#swagger)
-- [WebSocket](#web-socket)
+- [WebSocket](#websocket)
 - [Example CRUD](#example-crud)
 
 ## Start Server
@@ -49,6 +52,35 @@ new Spear()
 
 ```
 
+## Adapter
+tspace-spear supports multiple server adapters, 
+including the native Node.js HTTP server and uWebSockets.js for high performance.
+
+⚠️ Requirements for uWebSockets.js
+Node.js 18 or higher is required
+Installation is done via GitHub (no official npm release)
+
+```js
+import { Spear } from "tspace-spear";
+import uWS from "uWebSockets.js";
+
+// Install via package.json
+// "dependencies": {
+//   "uWebSockets.js": "github:uNetworking/uWebSockets.js#v20.45.0"
+// }
+
+new Spear({ adapter: uWS })
+.get("/", () => "Hello world!")
+.get("/json", () => {
+  return {
+    message: "Hello world!",
+  };
+})
+.listen(3000, () =>
+  console.log("uWS server is running at http://localhost:3000")
+);
+```
+
 ## Cluster
 ```js
 import { Spear } from "tspace-spear";
@@ -619,7 +651,7 @@ class CatController {
         file : {
           type : 'array',
           items: {
-            type:"file",
+            type  :"string",
             format:"binary"
           }
         },

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

@@ -25,6 +25,7 @@ declare class Spear {
     private readonly _globalPrefix;
     private readonly _router;
     private readonly _parser;
+    private _adapter;
     private _cluster?;
     private _cors?;
     private _swagger;
@@ -37,7 +38,7 @@ declare class Spear {
     private _formatResponse;
     private _onListeners;
     private _fileUploadOptions;
-    constructor({ controllers, middlewares, globalPrefix, logger, cluster }?: T.Application);
+    constructor({ controllers, middlewares, globalPrefix, logger, cluster, adapter }?: T.Application);
     /**
      * The get 'instance' method is used to get the instance of Spear.
      *
@@ -67,6 +68,14 @@ declare class Spear {
      * @returns {this}
      */
     use(middleware: (ctx: T.Context, next: T.NextFunction) => void): this;
+    /**
+     * The 'useAdater' method is used to switch between different server implementations,
+     * such as the native Node.js HTTP server or uWebSockets.js (uWS).
+     *
+     * @param {T.Adapter} adapter - The adapter instance (e.g., HTTP or uWS).
+     * @returns {this} Returns the current instance for chaining
+     */
+    useAdater(adapter: T.Adapter): this;
     /**
      * The 'useCluster' method is used cluster run the server
      *
@@ -274,7 +283,6 @@ declare class Spear {
     * @returns {this}
     */
     all(path: string, ...handlers: ((ctx: T.Context, next: T.NextFunction) => any)[]): this;
-    private _clusterMode;
     private _import;
     private _registerControllers;
     private _registerMiddlewares;
@@ -282,7 +290,9 @@ declare class Spear {
     private _wrapHandlers;
     private _wrapResponse;
     private _nextFunction;
+    private _clusterMode;
     private _createServer;
+    private _uWSRequestResponse;
     private _normalizePath;
     private _swaggerHandler;
 }