tspace-spear 1.2.3 → 1.2.4

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

@@ -1,6 +1,6 @@
 import { Server } from 'http';
-import findMyWayRouter, { type Instance } from 'find-my-way';
 import WebSocket from 'ws';
+import { FastRouter } from './fast-router';
 import { Router } from './router';
 import type { T } from '../types';
 /**
@@ -22,17 +22,15 @@ import type { T } from '../types';
 declare class Spear {
     private readonly _controllers?;
     private readonly _middlewares?;
-    private readonly _globalPrefix;
     private readonly _router;
     private readonly _parser;
+    private _globalPrefix;
     private _adapter;
     private _cluster?;
     private _cors?;
     private _swagger;
     private _swaggerSpecs;
-    private _wss?;
-    private _ws?;
-    private _wsOptions?;
+    private _ws;
     private _errorHandler;
     private _globalMiddlewares;
     private _formatResponse;
@@ -48,9 +46,9 @@ declare class Spear {
     /**
      * The get 'routers' method is used get the all routers.
      *
-     * @returns {Instance<findMyWayRouter.HTTPVersion.V1>}
+     * @returns {FastRouter}
      */
-    get routers(): Instance<findMyWayRouter.HTTPVersion.V1>;
+    get routers(): FastRouter;
     /**
      * The 'ws' method is used to creates the WebSocket server.
      *
@@ -67,15 +65,25 @@ declare class Spear {
      * @property  {Function} next  - go to next function
      * @returns {this}
      */
-    use(middleware: (ctx: T.Context, next: T.NextFunction) => void): this;
+    use(middleware: T.ContextHandler): this;
+    /**
+     * The 'useGlobalPrefix' method is used to sets a global prefix for all routes in the router.
+     *
+     * If `globalPrefix` is `null` or `undefined`, it will default to an empty string,
+     * meaning no prefix will be applied.
+     *
+     * @param {string | null} globalPrefix - The base path prefix to apply to all routes.
+     * @returns {this} Returns the current instance for method chaining.
+     */
+    useGlobalPrefix(globalPrefix: string | null): 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).
+     * @param {T.AdapterServer} adapter - The adapter instance (e.g., HTTP or uWS).
      * @returns {this} Returns the current instance for chaining
      */
-    useAdater(adapter: T.Adapter): this;
+    useAdater(adapter: T.AdapterServer): this;
     /**
      * The 'useCluster' method is used cluster run the server
      *
@@ -108,11 +116,11 @@ declare class Spear {
      * 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 {?number} limits // bytes. default Infinity
      * @property {?string} tempFileDir
      * @property {?Object} removeTempFile
      * @property {boolean} removeTempFile.remove
-     * @property {number} removeTempFile.ms
+     * @property {number}  removeTempFile.ms
      * @returns
      */
     useFileUpload({ limit, tempFileDir, removeTempFile }?: {
@@ -176,7 +184,7 @@ declare class Spear {
      * @param {function} format
      * @returns
      */
-    response(format: (r: unknown, statusCode: number) => any): this;
+    response(format: (r: unknown, statusCode: number) => Record<string, any> | string): this;
     /**
      * The 'catch' method is middleware that is specifically designed to handle errors.
      *
@@ -185,14 +193,14 @@ declare class Spear {
      * @param {function} error
      * @returns
      */
-    catch(error: (err: any, ctx: T.Context) => any): this;
+    catch(error: (err: any, ctx: T.Context) => T.Response): 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;
+    notfound(fn: (ctx: T.Context) => T.Response): this;
     /**
      * The 'get' method is used to add the request handler to the router for the 'GET' method.
      *
@@ -202,7 +210,7 @@ declare class Spear {
      * @property  {Function} next  - go to next function
      * @returns {this}
      */
-    get(path: string, ...handlers: ((ctx: T.Context, next: T.NextFunction) => any)[]): this;
+    get(path: string, ...handlers: T.ContextHandler[]): this;
     /**
      * The 'post' method is used to add the request handler to the router for the 'POST' method.
      *
@@ -212,7 +220,7 @@ declare class Spear {
      * @property  {Function} next  - go to next function
      * @returns {this}
      */
-    post(path: string, ...handlers: ((ctx: T.Context, next: T.NextFunction) => any)[]): this;
+    post(path: string, ...handlers: T.ContextHandler[]): this;
     /**
      * The 'put' method is used to add the request handler to the router for the 'PUT' method.
      *
@@ -222,7 +230,7 @@ declare class Spear {
      * @property  {Function} next  - go to next function
      * @returns {this}
      */
-    put(path: string, ...handlers: ((ctx: T.Context, next: T.NextFunction) => any)[]): this;
+    put(path: string, ...handlers: T.ContextHandler[]): this;
     /**
      * The 'patch' method is used to add the request handler to the router for the 'PATCH' method.
      *
@@ -232,7 +240,7 @@ declare class Spear {
      * @property  {Function} next  - go to next function
      * @returns {this}
      */
-    patch(path: string, ...handlers: ((ctx: T.Context, next: T.NextFunction) => any)[]): this;
+    patch(path: string, ...handlers: T.ContextHandler[]): this;
     /**
      * The 'delete' method is used to add the request handler to the router for the 'DELETE' method.
      *
@@ -242,7 +250,7 @@ declare class Spear {
      * @property  {Function} next  - go to next function
      * @returns {this}
      */
-    delete(path: string, ...handlers: ((ctx: T.Context, next: T.NextFunction) => any)[]): this;
+    delete(path: string, ...handlers: T.ContextHandler[]): this;
     /**
      * The 'head' method is used to add the request handler to the router for 'HEAD' methods.
      *
@@ -252,7 +260,7 @@ declare class Spear {
      * @property  {function} next  - go to next function
      * @returns {this}
      */
-    head(path: string, ...handlers: ((ctx: T.Context, next: T.NextFunction) => any)[]): this;
+    head(path: string, ...handlers: T.ContextHandler[]): this;
     /**
      * The 'head' method is used to add the request handler to the router for 'HEAD' methods.
      *
@@ -262,9 +270,9 @@ declare class Spear {
      * @property  {function} next  - go to next function
      * @returns {this}
      */
-    options(path: string, ...handlers: ((ctx: T.Context, next: T.NextFunction) => any)[]): this;
+    options(path: string, ...handlers: T.ContextHandler[]): this;
     /**
-     * The 'any' method is used to add the request handler to the router for 'GET' 'POST' 'PUT' 'PATCH' 'DELETE' 'HEAD' 'OPTIONS' methods.
+     * 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
@@ -272,27 +280,16 @@ declare class Spear {
      * @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;
+    all(path: string, ...handlers: T.ContextHandler[]): this;
     private _import;
     private _registerControllers;
     private _registerMiddlewares;
-    private _customizeResponse;
     private _wrapHandlers;
     private _wrapResponse;
-    private _nextFunction;
+    private _nextError;
     private _clusterMode;
     private _createServer;
-    private _uWSRequestResponse;
+    private _createContext;
     private _normalizePath;
     private _swaggerHandler;
 }