clear-router 2.5.0 → 2.5.2

package/dist/hono/index.cjs

@@ -1,5 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_router = require('../router-Cxi21bzi.cjs');
+const require_router = require('../router-CHg0pZUO.cjs');
 const require_responses = require('../responses-r-O3jS-S.cjs');
 
 //#region src/hono/router.ts
@@ -47,7 +47,7 @@ var Router = class Router extends require_router.CoreRouter {
 		return body;
 	}
 	/**
-	* Resolve method override from query, headers, or body
+	* Adds a new route to the router.
 	* 
 	* @param methods 
 	* @param path 
@@ -138,7 +138,7 @@ var Router = class Router extends require_router.CoreRouter {
 		super.head(path, handler, middlewares);
 	}
 	/**
-	* Define a group of routes with a common prefix and optional middlewares
+	* Defines a group of routes with a common prefix.
 	* 
 	* @param prefix 
 	* @param callback 

package/dist/hono/index.d.cts

@@ -1,4 +1,4 @@
-import { d as ApiResourceMiddleware, f as ControllerAction, m as HttpMethod, n as ClearRequest, p as ControllerHandler, r as Route, t as CoreRouter } from "../router-A-9JuZPi.cjs";
+import { d as ApiResourceMiddleware, f as ControllerAction, m as HttpMethod, n as ClearRequest, p as ControllerHandler, r as Route, t as CoreRouter } from "../router-CS_2XQ7I.cjs";
 import { Context, HonoRequest, MiddlewareHandler } from "hono";
 
 //#region types/hono.d.ts
@@ -27,7 +27,7 @@ declare class Router extends CoreRouter {
   private static getParams;
   private static readBodyCached;
   /**
-   * Resolve method override from query, headers, or body
+   * Adds a new route to the router.
    *
    * @param methods
    * @param path
@@ -104,7 +104,7 @@ declare class Router extends CoreRouter {
    */
   static head(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
   /**
-   * Define a group of routes with a common prefix and optional middlewares
+   * Defines a group of routes with a common prefix.
    *
    * @param prefix
    * @param callback

package/dist/hono/index.d.mts

@@ -1,4 +1,4 @@
-import { d as ApiResourceMiddleware, f as ControllerAction, m as HttpMethod, n as ClearRequest, p as ControllerHandler, r as Route, t as CoreRouter } from "../router-CVeqd7Ro.mjs";
+import { d as ApiResourceMiddleware, f as ControllerAction, m as HttpMethod, n as ClearRequest, p as ControllerHandler, r as Route, t as CoreRouter } from "../router-_w2VzMQF.mjs";
 import { Context, HonoRequest, MiddlewareHandler } from "hono";
 
 //#region types/hono.d.ts
@@ -27,7 +27,7 @@ declare class Router extends CoreRouter {
   private static getParams;
   private static readBodyCached;
   /**
-   * Resolve method override from query, headers, or body
+   * Adds a new route to the router.
    *
    * @param methods
    * @param path
@@ -104,7 +104,7 @@ declare class Router extends CoreRouter {
    */
   static head(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
   /**
-   * Define a group of routes with a common prefix and optional middlewares
+   * Defines a group of routes with a common prefix.
    *
    * @param prefix
    * @param callback

package/dist/hono/index.mjs

@@ -1,4 +1,4 @@
-import { t as CoreRouter } from "../router-Dxc8FQOl.mjs";
+import { t as CoreRouter } from "../router-BReOXz-F.mjs";
 import { n as resolveResponseMeta } from "../responses-HOePPAl8.mjs";
 
 //#region src/hono/router.ts
@@ -46,7 +46,7 @@ var Router = class Router extends CoreRouter {
 		return body;
 	}
 	/**
-	* Resolve method override from query, headers, or body
+	* Adds a new route to the router.
 	* 
 	* @param methods 
 	* @param path 
@@ -137,7 +137,7 @@ var Router = class Router extends CoreRouter {
 		super.head(path, handler, middlewares);
 	}
 	/**
-	* Define a group of routes with a common prefix and optional middlewares
+	* Defines a group of routes with a common prefix.
 	* 
 	* @param prefix 
 	* @param callback 

package/dist/index.cjs

@@ -255,7 +255,7 @@ var CoreRouter = class {
 		return null;
 	}
 	/**
-	* Adds a new route to the router with the specified methods, path, handler, and middlewares.
+	* Adds a new route to the router.
 	* 
 	* @param this 
 	* @param methods 
@@ -285,8 +285,7 @@ var CoreRouter = class {
 		}
 	}
 	/**
-	* Adds a new API resource route to the router for the specified base path and controller, with 
-	* options to include/exclude specific actions and apply middlewares.
+	* Define a resourceful API controller with standard CRUD routes.
 	* 
 	* @param this 
 	* @param basePath 
@@ -329,7 +328,7 @@ var CoreRouter = class {
 		}
 	}
 	/**
-	* Adds a new GET route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new GET route to the router.
 	* 
 	* @param this          The router instance.
 	* @param path          The path for the GET route.
@@ -340,7 +339,7 @@ var CoreRouter = class {
 		this.add("get", path, handler, middlewares);
 	}
 	/**
-	* Adds a new POST route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new POST route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -351,7 +350,7 @@ var CoreRouter = class {
 		this.add("post", path, handler, middlewares);
 	}
 	/**
-	* Adds a new PUT route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new PUT route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -362,7 +361,7 @@ var CoreRouter = class {
 		this.add("put", path, handler, middlewares);
 	}
 	/**
-	* Adds a new DELETE route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new DELETE route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -373,7 +372,7 @@ var CoreRouter = class {
 		this.add("delete", path, handler, middlewares);
 	}
 	/**
-	* Adds a new PATCH route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new PATCH route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -384,7 +383,7 @@ var CoreRouter = class {
 		this.add("patch", path, handler, middlewares);
 	}
 	/**
-	* Adds a new OPTIONS route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new OPTIONS route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -395,7 +394,7 @@ var CoreRouter = class {
 		this.add("options", path, handler, middlewares);
 	}
 	/**
-	* Adds a new HEAD route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new HEAD route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -406,8 +405,7 @@ var CoreRouter = class {
 		this.add("head", path, handler, middlewares);
 	}
 	/**
-	* Defines a group of routes with a common prefix and optional middlewares, allowing for better 
-	* organization and reuse of route configurations.
+	* Defines a group of routes with a common prefix.
 	* 
 	* @param this 
 	* @param prefix 

package/dist/index.d.cts

@@ -145,7 +145,7 @@ declare abstract class CoreRouter {
   static configure(this: any, options?: RouterConfig): void;
   protected static resolveMethodOverride(this: any, method: string, headers: Headers | Record<string, any>, body: unknown): HttpMethod | null;
   /**
-   * Adds a new route to the router with the specified methods, path, handler, and middlewares.
+   * Adds a new route to the router.
    *
    * @param this
    * @param methods
@@ -155,8 +155,7 @@ declare abstract class CoreRouter {
    */
   static add(this: any, methods: HttpMethod | HttpMethod[], path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Adds a new API resource route to the router for the specified base path and controller, with
-   * options to include/exclude specific actions and apply middlewares.
+   * Define a resourceful API controller with standard CRUD routes.
    *
    * @param this
    * @param basePath
@@ -169,7 +168,7 @@ declare abstract class CoreRouter {
     middlewares?: ApiResourceMiddleware<any>;
   }): void;
   /**
-   * Adds a new GET route to the router with the specified path, handler, and optional middlewares.
+   * Adds a new GET route to the router.
    *
    * @param this          The router instance.
    * @param path          The path for the GET route.
@@ -178,7 +177,7 @@ declare abstract class CoreRouter {
    */
   static get(this: any, path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Adds a new POST route to the router with the specified path, handler, and optional middlewares.
+   * Adds a new POST route to the router.
    *
    * @param this
    * @param path
@@ -187,7 +186,7 @@ declare abstract class CoreRouter {
    */
   static post(this: any, path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Adds a new PUT route to the router with the specified path, handler, and optional middlewares.
+   * Adds a new PUT route to the router.
    *
    * @param this
    * @param path
@@ -196,7 +195,7 @@ declare abstract class CoreRouter {
    */
   static put(this: any, path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Adds a new DELETE route to the router with the specified path, handler, and optional middlewares.
+   * Adds a new DELETE route to the router.
    *
    * @param this
    * @param path
@@ -205,7 +204,7 @@ declare abstract class CoreRouter {
    */
   static delete(this: any, path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Adds a new PATCH route to the router with the specified path, handler, and optional middlewares.
+   * Adds a new PATCH route to the router.
    *
    * @param this
    * @param path
@@ -214,7 +213,7 @@ declare abstract class CoreRouter {
    */
   static patch(this: any, path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Adds a new OPTIONS route to the router with the specified path, handler, and optional middlewares.
+   * Adds a new OPTIONS route to the router.
    *
    * @param this
    * @param path
@@ -223,7 +222,7 @@ declare abstract class CoreRouter {
    */
   static options(this: any, path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Adds a new HEAD route to the router with the specified path, handler, and optional middlewares.
+   * Adds a new HEAD route to the router.
    *
    * @param this
    * @param path
@@ -232,8 +231,7 @@ declare abstract class CoreRouter {
    */
   static head(this: any, path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Defines a group of routes with a common prefix and optional middlewares, allowing for better
-   * organization and reuse of route configurations.
+   * Defines a group of routes with a common prefix.
    *
    * @param this
    * @param prefix

package/dist/index.d.mts

@@ -145,7 +145,7 @@ declare abstract class CoreRouter {
   static configure(this: any, options?: RouterConfig): void;
   protected static resolveMethodOverride(this: any, method: string, headers: Headers | Record<string, any>, body: unknown): HttpMethod | null;
   /**
-   * Adds a new route to the router with the specified methods, path, handler, and middlewares.
+   * Adds a new route to the router.
    *
    * @param this
    * @param methods
@@ -155,8 +155,7 @@ declare abstract class CoreRouter {
    */
   static add(this: any, methods: HttpMethod | HttpMethod[], path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Adds a new API resource route to the router for the specified base path and controller, with
-   * options to include/exclude specific actions and apply middlewares.
+   * Define a resourceful API controller with standard CRUD routes.
    *
    * @param this
    * @param basePath
@@ -169,7 +168,7 @@ declare abstract class CoreRouter {
     middlewares?: ApiResourceMiddleware<any>;
   }): void;
   /**
-   * Adds a new GET route to the router with the specified path, handler, and optional middlewares.
+   * Adds a new GET route to the router.
    *
    * @param this          The router instance.
    * @param path          The path for the GET route.
@@ -178,7 +177,7 @@ declare abstract class CoreRouter {
    */
   static get(this: any, path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Adds a new POST route to the router with the specified path, handler, and optional middlewares.
+   * Adds a new POST route to the router.
    *
    * @param this
    * @param path
@@ -187,7 +186,7 @@ declare abstract class CoreRouter {
    */
   static post(this: any, path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Adds a new PUT route to the router with the specified path, handler, and optional middlewares.
+   * Adds a new PUT route to the router.
    *
    * @param this
    * @param path
@@ -196,7 +195,7 @@ declare abstract class CoreRouter {
    */
   static put(this: any, path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Adds a new DELETE route to the router with the specified path, handler, and optional middlewares.
+   * Adds a new DELETE route to the router.
    *
    * @param this
    * @param path
@@ -205,7 +204,7 @@ declare abstract class CoreRouter {
    */
   static delete(this: any, path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Adds a new PATCH route to the router with the specified path, handler, and optional middlewares.
+   * Adds a new PATCH route to the router.
    *
    * @param this
    * @param path
@@ -214,7 +213,7 @@ declare abstract class CoreRouter {
    */
   static patch(this: any, path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Adds a new OPTIONS route to the router with the specified path, handler, and optional middlewares.
+   * Adds a new OPTIONS route to the router.
    *
    * @param this
    * @param path
@@ -223,7 +222,7 @@ declare abstract class CoreRouter {
    */
   static options(this: any, path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Adds a new HEAD route to the router with the specified path, handler, and optional middlewares.
+   * Adds a new HEAD route to the router.
    *
    * @param this
    * @param path
@@ -232,8 +231,7 @@ declare abstract class CoreRouter {
    */
   static head(this: any, path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Defines a group of routes with a common prefix and optional middlewares, allowing for better
-   * organization and reuse of route configurations.
+   * Defines a group of routes with a common prefix.
    *
    * @param this
    * @param prefix

package/dist/index.mjs

@@ -254,7 +254,7 @@ var CoreRouter = class {
 		return null;
 	}
 	/**
-	* Adds a new route to the router with the specified methods, path, handler, and middlewares.
+	* Adds a new route to the router.
 	* 
 	* @param this 
 	* @param methods 
@@ -284,8 +284,7 @@ var CoreRouter = class {
 		}
 	}
 	/**
-	* Adds a new API resource route to the router for the specified base path and controller, with 
-	* options to include/exclude specific actions and apply middlewares.
+	* Define a resourceful API controller with standard CRUD routes.
 	* 
 	* @param this 
 	* @param basePath 
@@ -328,7 +327,7 @@ var CoreRouter = class {
 		}
 	}
 	/**
-	* Adds a new GET route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new GET route to the router.
 	* 
 	* @param this          The router instance.
 	* @param path          The path for the GET route.
@@ -339,7 +338,7 @@ var CoreRouter = class {
 		this.add("get", path, handler, middlewares);
 	}
 	/**
-	* Adds a new POST route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new POST route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -350,7 +349,7 @@ var CoreRouter = class {
 		this.add("post", path, handler, middlewares);
 	}
 	/**
-	* Adds a new PUT route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new PUT route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -361,7 +360,7 @@ var CoreRouter = class {
 		this.add("put", path, handler, middlewares);
 	}
 	/**
-	* Adds a new DELETE route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new DELETE route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -372,7 +371,7 @@ var CoreRouter = class {
 		this.add("delete", path, handler, middlewares);
 	}
 	/**
-	* Adds a new PATCH route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new PATCH route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -383,7 +382,7 @@ var CoreRouter = class {
 		this.add("patch", path, handler, middlewares);
 	}
 	/**
-	* Adds a new OPTIONS route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new OPTIONS route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -394,7 +393,7 @@ var CoreRouter = class {
 		this.add("options", path, handler, middlewares);
 	}
 	/**
-	* Adds a new HEAD route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new HEAD route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -405,8 +404,7 @@ var CoreRouter = class {
 		this.add("head", path, handler, middlewares);
 	}
 	/**
-	* Defines a group of routes with a common prefix and optional middlewares, allowing for better 
-	* organization and reuse of route configurations.
+	* Defines a group of routes with a common prefix.
 	* 
 	* @param this 
 	* @param prefix 

package/dist/koa/index.cjs

@@ -1,5 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_router = require('../router-Cxi21bzi.cjs');
+const require_router = require('../router-CHg0pZUO.cjs');
 const require_responses = require('../responses-r-O3jS-S.cjs');
 
 //#region src/koa/router.ts
@@ -57,41 +57,113 @@ var Router = class Router extends require_router.CoreRouter {
 		return ctx.body;
 	}
 	/**
-	* Adds a new route to the router with the specified HTTP methods, path, handler, and optional middlewares.
+	* Adds a new route to the router.
+	*
+	* @param methods
+	* @param path
+	* @param handler
+	* @param middlewares
 	*/
 	static add(methods, path, handler, middlewares) {
 		super.add(methods, path, handler, middlewares);
 	}
 	/**
-	* Adds a new API resource route to the router for the specified base path and controller.
+	* Define a resourceful API controller with standard CRUD routes
+	*
+	* @param basePath
+	* @param controller
+	* @param options
 	*/
 	static apiResource(basePath, controller, options) {
 		super.apiResource(basePath, controller, options);
 	}
+	/**
+	* Define a GET route
+	*
+	* @param path
+	* @param handler
+	* @param middlewares
+	*/
 	static get(path, handler, middlewares) {
 		super.get(path, handler, middlewares);
 	}
+	/**
+	* Define a POST route
+	*
+	* @param path
+	* @param handler
+	* @param middlewares
+	*/
 	static post(path, handler, middlewares) {
 		super.post(path, handler, middlewares);
 	}
+	/**
+	* Define a PUT route
+	*
+	* @param path
+	* @param handler
+	* @param middlewares
+	*/
 	static put(path, handler, middlewares) {
 		super.put(path, handler, middlewares);
 	}
+	/**
+	* Define a DELETE route
+	*
+	* @param path
+	* @param handler
+	* @param middlewares
+	*/
 	static delete(path, handler, middlewares) {
 		super.delete(path, handler, middlewares);
 	}
+	/**
+	* Define a PATCH route 
+	* 
+	* @param path 
+	* @param handler 
+	* @param middlewares 
+	*/
 	static patch(path, handler, middlewares) {
 		super.patch(path, handler, middlewares);
 	}
+	/**
+	* Define an OPTIONS route
+	*
+	* @param path
+	* @param handler
+	* @param middlewares
+	*/
 	static options(path, handler, middlewares) {
 		super.options(path, handler, middlewares);
 	}
+	/**
+	* Adds a new HEAD route to the router.
+	*
+	* @param this
+	* @param path
+	* @param handler
+	* @param middlewares
+	*/
 	static head(path, handler, middlewares) {
 		super.head(path, handler, middlewares);
 	}
+	/**
+	* Defines a group of routes with a common prefix.
+	*
+	* @param prefix
+	* @param callback
+	* @param middlewares
+	*/
 	static async group(prefix, callback, middlewares) {
 		await super.group(prefix, callback, middlewares);
 	}
+	/**
+	* Apply middlewares to a group of routes defined within the callback
+	* 
+	* @param middlewares  - Middleware or array of middlewares to apply
+	* @param callback     - Function that defines the routes to which the middlewares will be applied
+	*/
 	static middleware(middlewares, callback) {
 		super.middleware(middlewares, callback);
 	}
@@ -99,7 +171,10 @@ var Router = class Router extends require_router.CoreRouter {
 		return super.allRoutes(type);
 	}
 	/**
-	* Applies the registered routes to a @koa/router instance.
+	* Apply the defined routes to a @koa/router instance
+	* 
+	* @param router  @koa/router instance
+	* @returns    The  @koa/router instance with the applied routes
 	*/
 	static apply(router) {
 		for (const route of this.routes) {