@eggjs/router 3.0.5 → 4.0.0-beta.16

package/README.md

@@ -2,9 +2,10 @@
 
 [![NPM version](https://img.shields.io/npm/v/@eggjs/router.svg?style=flat-square)](https://npmjs.org/package/@eggjs/router)
 [![NPM download](https://img.shields.io/npm/dm/@eggjs/router.svg?style=flat-square)](https://npmjs.org/package/@eggjs/router)
-[![Node.js CI](https://github.com/eggjs/egg-router/actions/workflows/nodejs.yml/badge.svg?branch=master)](https://github.com/eggjs/egg-router/actions/workflows/nodejs.yml)
-[![Test coverage](https://img.shields.io/codecov/c/github/eggjs/egg-router.svg?style=flat-square)](https://codecov.io/gh/eggjs/egg-router)
 [![Known Vulnerabilities](https://snyk.io/test/npm/@eggjs/router/badge.svg?style=flat-square)](https://snyk.io/test/npm/@eggjs/router)
+[![Node.js Version](https://img.shields.io/node/v/@eggjs/router.svg?style=flat)](https://nodejs.org/en/download/)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
+![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/eggjs/router)
 
 Router core component for [Egg.js](https://github.com/eggjs).
 
@@ -48,9 +49,9 @@ Router core component for [Egg.js](https://github.com/eggjs).
 
 Create a new router.
 
-| Param | Type | Description |
-| ---   | ---   | --- |
-| [opts] | <code>Object</code> |  |
+| Param         | Type                | Description         |
+| ------------- | ------------------- | ------------------- |
+| [opts]        | <code>Object</code> |                     |
 | [opts.prefix] | <code>String</code> | prefix router paths |
 
 **Example**
@@ -67,16 +68,14 @@ router.get('/', async (ctx, next) => {
   // ctx.router available
 });
 
-app
-  .use(router.routes())
-  .use(router.allowedMethods());
+app.use(router.routes()).use(router.allowedMethods());
 ```
 
 <a name="module_egg-router--Router+get|put|post|patch|delete|del"></a>
 
 #### router.get|put|post|patch|delete|del ⇒ <code>Router</code>
 
-Create `router.verb()` methods, where *verb* is one of the HTTP verbs such
+Create `router.verb()` methods, where _verb_ is one of the HTTP verbs such
 as `router.get()` or `router.post()`.
 
 Match URL patterns to callback functions or controller actions using `router.verb()`,
@@ -118,7 +117,7 @@ renaming of URLs during development.
 
 ```ts
 router.get('user', '/users/:id', (ctx, next) => {
- // ...
+  // ...
 });
 
 router.url('user', 3);
@@ -133,7 +132,7 @@ Multiple middleware may be given:
 router.get(
   '/users/:id',
   (ctx, next) => {
-    return User.findOne(ctx.params.id).then(function(user) {
+    return User.findOne(ctx.params.id).then(function (user) {
       ctx.user = user;
       next();
     });
@@ -190,15 +189,16 @@ used to convert paths to regular expressions.
 
 **Kind**: instance property of <code>[Router](#exp_module_egg-router--Router)</code>
 
-| Param | Type | Description |
-| ---   | ---  | --- |
-| path | <code>String</code> |  |
+| Param        | Type                  | Description         |
+| ------------ | --------------------- | ------------------- |
+| path         | <code>String</code>   |                     |
 | [middleware] | <code>function</code> | route middleware(s) |
-| callback | <code>function</code> | route callback |
+| callback     | <code>function</code> | route callback      |
 
 <a name="module_egg-router--Router+routes"></a>
 
 #### router.routes ⇒ <code>function</code>
+
 Returns router middleware which dispatches a route matching the request.
 
 **Kind**: instance property of <code>[Router](#exp_module_egg-router--Router)</code>
@@ -214,19 +214,17 @@ sequentially, requests start at the first middleware and work their way
 
 **Kind**: instance method of <code>[Router](#exp_module_egg-router--Router)</code>
 
-| Param | Type |
-| --- | --- |
-| [path] | <code>String</code> |
+| Param      | Type                  |
+| ---------- | --------------------- |
+| [path]     | <code>String</code>   |
 | middleware | <code>function</code> |
-| [...] | <code>function</code> |
+| [...]      | <code>function</code> |
 
 **Example**
 
 ```ts
 // session middleware will run before authorize
-router
-  .use(session())
-  .use(authorize());
+router.use(session()).use(authorize());
 
 // use middleware only with given path
 router.use('/users', userAuth());
@@ -245,14 +243,14 @@ Set the path prefix for a Router instance that was already initialized.
 
 **Kind**: instance method of <code>[Router](#exp_module_egg-router--Router)</code>
 
-| Param | Type |
-| --- | --- |
+| Param  | Type                |
+| ------ | ------------------- |
 | prefix | <code>String</code> |
 
 **Example**
 
 ```ts
-router.prefix('/things/:thing_id')
+router.prefix('/things/:thing_id');
 ```
 
 <a name="module_egg-router--Router+allowedMethods"></a>
@@ -265,11 +263,11 @@ with `405 Method Not Allowed` and `501 Not Implemented` as appropriate.
 
 **Kind**: instance method of <code>[Router](#exp_module_egg-router--Router)</code>
 
-| Param | Type | Description |
-| --- | --- | --- |
-| [options] | <code>Object</code> |  |
-| [options.throw] | <code>Boolean</code> | throw error instead of setting status and header |
-| [options.notImplemented] | <code>function</code> | throw the returned value in place of the default NotImplemented error |
+| Param                      | Type                  | Description                                                             |
+| -------------------------- | --------------------- | ----------------------------------------------------------------------- |
+| [options]                  | <code>Object</code>   |                                                                         |
+| [options.throw]            | <code>Boolean</code>  | throw error instead of setting status and header                        |
+| [options.notImplemented]   | <code>function</code> | throw the returned value in place of the default NotImplemented error   |
 | [options.methodNotAllowed] | <code>function</code> | throw the returned value in place of the default MethodNotAllowed error |
 
 **Example**
@@ -296,11 +294,13 @@ const app = new Koa();
 const router = new Router();
 
 app.use(router.routes());
-app.use(router.allowedMethods({
-  throw: true,
-  notImplemented: () => new Boom.notImplemented(),
-  methodNotAllowed: () => new Boom.methodNotAllowed()
-}));
+app.use(
+  router.allowedMethods({
+    throw: true,
+    notImplemented: () => new Boom.notImplemented(),
+    methodNotAllowed: () => new Boom.methodNotAllowed(),
+  })
+);
 ```
 
 <a name="module_egg-router--Router+redirect"></a>
@@ -326,11 +326,11 @@ router.all('/login', ctx => {
 
 **Kind**: instance method of <code>[Router](#exp_module_egg-router--Router)</code>
 
-| Param | Type | Description |
-| --- | --- | --- |
-| source | <code>String</code> | URL or route name. |
-| destination | <code>String</code> | URL or route name. |
-| [code] | <code>Number</code> | HTTP status code (default: 301). |
+| Param       | Type                | Description                      |
+| ----------- | ------------------- | -------------------------------- |
+| source      | <code>String</code> | URL or route name.               |
+| destination | <code>String</code> | URL or route name.               |
+| [code]      | <code>Number</code> | HTTP status code (default: 301). |
 
 <a name="module_egg-router--Router+route"></a>
 
@@ -340,9 +340,9 @@ Lookup route with given `name`.
 
 **Kind**: instance method of <code>[Router](#exp_module_egg-router--Router)</code>
 
-| Param | Type |
-| --- | --- |
-| name | <code>String</code> |
+| Param | Type                |
+| ----- | ------------------- |
+| name  | <code>String</code> |
 
 <a name="module_egg-router--Router+url"></a>
 
@@ -352,12 +352,12 @@ Generate URL for route. Takes a route name and map of named `params`.
 
 **Kind**: instance method of <code>[Router](#exp_module_egg-router--Router)</code>
 
-| Param | Type | Description |
-| --- | --- | --- |
-| name | <code>String</code> | route name |
-| params | <code>Object</code> | url parameters |
-| [options] | <code>Object</code> | options parameter |
-| [options.query] | <code>Object</code> &#124; <code>String</code> | query options |
+| Param           | Type                                           | Description       |
+| --------------- | ---------------------------------------------- | ----------------- |
+| name            | <code>String</code>                            | route name        |
+| params          | <code>Object</code>                            | url parameters    |
+| [options]       | <code>Object</code>                            | options parameter |
+| [options.query] | <code>Object</code> &#124; <code>String</code> | query options     |
 
 **Example**
 
@@ -375,12 +375,12 @@ router.url('user', { id: 3 });
 router.use((ctx, next) => {
   // redirect to named route
   ctx.redirect(ctx.router.url('sign-in'));
-})
+});
 
 router.url('user', { id: 3 }, { query: { limit: 1 } });
 // => "/users/3?limit=1"
 
-router.url('user', { id: 3 }, { query: "limit=1" });
+router.url('user', { id: 3 }, { query: 'limit=1' });
 // => "/users/3?limit=1"
 ```
 
@@ -393,9 +393,9 @@ validation.
 
 **Kind**: instance method of <code>[Router](#exp_module_egg-router--Router)</code>
 
-| Param | Type |
-| --- | --- |
-| param | <code>String</code> |
+| Param      | Type                  |
+| ---------- | --------------------- |
+| param      | <code>String</code>   |
 | middleware | <code>function</code> |
 
 **Example**
@@ -404,19 +404,19 @@ validation.
 router
   .param('user', (id, ctx, next) => {
     ctx.user = users[id];
-    if (!ctx.user) return ctx.status = 404;
+    if (!ctx.user) return (ctx.status = 404);
     return next();
   })
   .get('/users/:user', ctx => {
     ctx.body = ctx.user;
   })
   .get('/users/:user/friends', ctx => {
-    return ctx.user.getFriends().then(function(friends) {
+    return ctx.user.getFriends().then(function (friends) {
       ctx.body = friends;
     });
-  })
-  // /users/3 => {"id": 3, "name": "Alex"}
-  // /users/3/friends => [{"id": 4, "name": "TJ"}]
+  });
+// /users/3 => {"id": 3, "name": "Alex"}
+// /users/3/friends => [{"id": 4, "name": "TJ"}]
 ```
 
 <a name="module_egg-router--Router.url"></a>
@@ -427,20 +427,20 @@ Generate URL from url pattern and given `params`.
 
 **Kind**: static method of <code>[Router](#exp_module_egg-router--Router)</code>
 
-| Param | Type | Description |
-| --- | --- | --- |
-| path | <code>String</code> | url pattern |
-| params | <code>Object</code> | url parameters |
-| [options] | <code>Object</code> | options parameter |
-| [options.query] | <code>Object</code> &#124; <code>String</code> | query options |
+| Param           | Type                                           | Description       |
+| --------------- | ---------------------------------------------- | ----------------- |
+| path            | <code>String</code>                            | url pattern       |
+| params          | <code>Object</code>                            | url parameters    |
+| [options]       | <code>Object</code>                            | options parameter |
+| [options.query] | <code>Object</code> &#124; <code>String</code> | query options     |
 
 **Example**
 
 ```ts
-const url = Router.url('/users/:id', {id: 1});
+const url = Router.url('/users/:id', { id: 1 });
 // => "/users/1"
 
-const url = Router.url('/users/:id', {id: 1}, {query: { active: true }});
+const url = Router.url('/users/:id', { id: 1 }, { query: { active: true } });
 // => "/users/1?active=true"
 ```
 
@@ -457,20 +457,8 @@ Run tests using `npm test`.
 
 [MIT](LICENSE)
 
-<!-- GITCONTRIBUTOR_START -->
-
 ## Contributors
 
-|[<img src="https://avatars.githubusercontent.com/u/1112718?v=4" width="100px;"/><br/><sub><b>alexmingoia</b></sub>](https://github.com/alexmingoia)<br/>|[<img src="https://avatars.githubusercontent.com/u/1413330?v=4" width="100px;"/><br/><sub><b>jbielick</b></sub>](https://github.com/jbielick)<br/>|[<img src="https://avatars.githubusercontent.com/u/985607?v=4" width="100px;"/><br/><sub><b>dead-horse</b></sub>](https://github.com/dead-horse)<br/>|[<img src="https://avatars.githubusercontent.com/u/156269?v=4" width="100px;"/><br/><sub><b>fengmk2</b></sub>](https://github.com/fengmk2)<br/>|[<img src="https://avatars.githubusercontent.com/u/1024246?v=4" width="100px;"/><br/><sub><b>wachunei</b></sub>](https://github.com/wachunei)<br/>|[<img src="https://avatars.githubusercontent.com/u/160197?v=4" width="100px;"/><br/><sub><b>dominicbarnes</b></sub>](https://github.com/dominicbarnes)<br/>|
-| :---: | :---: | :---: | :---: | :---: | :---: |
-|[<img src="https://avatars.githubusercontent.com/u/25254?v=4" width="100px;"/><br/><sub><b>tj</b></sub>](https://github.com/tj)<br/>|[<img src="https://avatars.githubusercontent.com/u/166834?v=4" width="100px;"/><br/><sub><b>aheckmann</b></sub>](https://github.com/aheckmann)<br/>|[<img src="https://avatars.githubusercontent.com/u/385716?v=4" width="100px;"/><br/><sub><b>kilianc</b></sub>](https://github.com/kilianc)<br/>|[<img src="https://avatars.githubusercontent.com/u/98955?v=4" width="100px;"/><br/><sub><b>secretfader</b></sub>](https://github.com/secretfader)<br/>|[<img src="https://avatars.githubusercontent.com/u/474587?v=4" width="100px;"/><br/><sub><b>ilkkao</b></sub>](https://github.com/ilkkao)<br/>|[<img src="https://avatars.githubusercontent.com/u/6873217?v=4" width="100px;"/><br/><sub><b>HeavenDuke</b></sub>](https://github.com/HeavenDuke)<br/>|
-|[<img src="https://avatars.githubusercontent.com/u/2842176?v=4" width="100px;"/><br/><sub><b>XadillaX</b></sub>](https://github.com/XadillaX)<br/>|[<img src="https://avatars.githubusercontent.com/u/200876?v=4" width="100px;"/><br/><sub><b>yiminghe</b></sub>](https://github.com/yiminghe)<br/>|[<img src="https://avatars.githubusercontent.com/u/32174276?v=4" width="100px;"/><br/><sub><b>semantic-release-bot</b></sub>](https://github.com/semantic-release-bot)<br/>|[<img src="https://avatars.githubusercontent.com/u/6794386?v=4" width="100px;"/><br/><sub><b>vkhv</b></sub>](https://github.com/vkhv)<br/>|[<img src="https://avatars.githubusercontent.com/u/7627362?v=4" width="100px;"/><br/><sub><b>vikramdurai</b></sub>](https://github.com/vikramdurai)<br/>|[<img src="https://avatars.githubusercontent.com/u/9271565?v=4" width="100px;"/><br/><sub><b>Tankenstein</b></sub>](https://github.com/Tankenstein)<br/>|
-|[<img src="https://avatars.githubusercontent.com/u/2822996?v=4" width="100px;"/><br/><sub><b>richardprior</b></sub>](https://github.com/richardprior)<br/>|[<img src="https://avatars.githubusercontent.com/u/1635441?v=4" width="100px;"/><br/><sub><b>joesonw</b></sub>](https://github.com/joesonw)<br/>|[<img src="https://avatars.githubusercontent.com/u/875091?v=4" width="100px;"/><br/><sub><b>ifroz</b></sub>](https://github.com/ifroz)<br/>|[<img src="https://avatars.githubusercontent.com/u/13130706?v=4" width="100px;"/><br/><sub><b>jeynish</b></sub>](https://github.com/jeynish)<br/>|[<img src="https://avatars.githubusercontent.com/u/72027?v=4" width="100px;"/><br/><sub><b>jergason</b></sub>](https://github.com/jergason)<br/>|[<img src="https://avatars.githubusercontent.com/u/227713?v=4" width="100px;"/><br/><sub><b>atian25</b></sub>](https://github.com/atian25)<br/>|
-|[<img src="https://avatars.githubusercontent.com/u/130963?v=4" width="100px;"/><br/><sub><b>lagden</b></sub>](https://github.com/lagden)<br/>|[<img src="https://avatars.githubusercontent.com/u/484559?v=4" width="100px;"/><br/><sub><b>fixe</b></sub>](https://github.com/fixe)<br/>|[<img src="https://avatars.githubusercontent.com/u/2671328?v=4" width="100px;"/><br/><sub><b>viliam-jobko</b></sub>](https://github.com/viliam-jobko)<br/>|[<img src="https://avatars.githubusercontent.com/u/2971112?v=4" width="100px;"/><br/><sub><b>mzyy94</b></sub>](https://github.com/mzyy94)<br/>|[<img src="https://avatars.githubusercontent.com/u/687842?v=4" width="100px;"/><br/><sub><b>jeromew</b></sub>](https://github.com/jeromew)<br/>|[<img src="https://avatars.githubusercontent.com/u/6897780?v=4" width="100px;"/><br/><sub><b>killagu</b></sub>](https://github.com/killagu)<br/>|
-|[<img src="https://avatars.githubusercontent.com/u/8069753?v=4" width="100px;"/><br/><sub><b>RobertHerhold</b></sub>](https://github.com/RobertHerhold)<br/>|[<img src="https://avatars.githubusercontent.com/u/4619802?v=4" width="100px;"/><br/><sub><b>yudppp</b></sub>](https://github.com/yudppp)<br/>|[<img src="https://avatars.githubusercontent.com/u/3173170?v=4" width="100px;"/><br/><sub><b>thedark1337</b></sub>](https://github.com/thedark1337)<br/>|[<img src="https://avatars.githubusercontent.com/u/6903313?v=4" width="100px;"/><br/><sub><b>x-cold</b></sub>](https://github.com/x-cold)<br/>|[<img src="https://avatars.githubusercontent.com/u/6713367?v=4" width="100px;"/><br/><sub><b>zzuieliyaoli</b></sub>](https://github.com/zzuieliyaoli)<br/>|[<img src="https://avatars.githubusercontent.com/u/81891?v=4" width="100px;"/><br/><sub><b>ryankask</b></sub>](https://github.com/ryankask)<br/>|
-|[<img src="https://avatars.githubusercontent.com/u/4810916?v=4" width="100px;"/><br/><sub><b>pschwyter</b></sub>](https://github.com/pschwyter)<br/>|[<img src="https://avatars.githubusercontent.com/u/62940?v=4" width="100px;"/><br/><sub><b>mikefrey</b></sub>](https://github.com/mikefrey)<br/>|[<img src="https://avatars.githubusercontent.com/u/300104?v=4" width="100px;"/><br/><sub><b>dizlexik</b></sub>](https://github.com/dizlexik)<br/>|[<img src="https://avatars.githubusercontent.com/u/2505474?v=4" width="100px;"/><br/><sub><b>jeffijoe</b></sub>](https://github.com/jeffijoe)<br/>|[<img src="https://avatars.githubusercontent.com/u/349336?v=4" width="100px;"/><br/><sub><b>iliakan</b></sub>](https://github.com/iliakan)<br/>|[<img src="https://avatars.githubusercontent.com/u/615334?v=4" width="100px;"/><br/><sub><b>frederickfogerty</b></sub>](https://github.com/frederickfogerty)<br/>|
-[<img src="https://avatars.githubusercontent.com/u/2552790?v=4" width="100px;"/><br/><sub><b>t3chnoboy</b></sub>](https://github.com/t3chnoboy)<br/>|[<img src="https://avatars.githubusercontent.com/u/1484279?v=4" width="100px;"/><br/><sub><b>bitinn</b></sub>](https://github.com/bitinn)<br/>|[<img src="https://avatars.githubusercontent.com/u/1441230?v=4" width="100px;"/><br/><sub><b>drGrove</b></sub>](https://github.com/drGrove)<br/>|[<img src="https://avatars.githubusercontent.com/u/12624092?v=4" width="100px;"/><br/><sub><b>CreativeCactus</b></sub>](https://github.com/CreativeCactus)<br/>|[<img src="https://avatars.githubusercontent.com/u/1773785?v=4" width="100px;"/><br/><sub><b>bguiz</b></sub>](https://github.com/bguiz)<br/>
-
-This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Sun Jun 16 2024 12:28:11 GMT+0800`.
+[![Contributors](https://contrib.rocks/image?repo=eggjs/egg)](https://github.com/eggjs/egg/graphs/contributors)
 
-<!-- GITCONTRIBUTOR_END -->
+Made with [contributors-img](https://contrib.rocks).

package/dist/EggRouter.d.ts

@@ -0,0 +1,108 @@
+import { MiddlewareFunc, ResourcesController } from "./types.js";
+import { Layer } from "./Layer.js";
+import { RegisterOptions, Router, RouterMethod, RouterOptions } from "./Router.js";
+
+//#region src/EggRouter.d.ts
+interface Application {
+  controller: Record<string, any>;
+}
+/**
+ * FIXME: move these patch into @eggjs/router
+ */
+declare class EggRouter extends Router {
+  readonly app: Application;
+  /**
+   * @class
+   * @param {Object} opts - Router options.
+   * @param {Application} app - Application object.
+   */
+  constructor(opts: RouterOptions, app: Application);
+  verb(method: RouterMethod | RouterMethod[], nameOrPath: string | RegExp | (string | RegExp)[], pathOrMiddleware: string | RegExp | (string | RegExp)[] | MiddlewareFunc, ...middleware: (MiddlewareFunc | string)[]): this;
+  head(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+  head(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+  options(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+  options(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+  get(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+  get(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+  put(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+  put(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+  patch(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+  patch(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+  post(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+  post(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+  delete(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+  delete(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+  all(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+  all(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+  register(path: string | RegExp | (string | RegExp)[], methods: string[], middleware: MiddlewareFunc | string | (MiddlewareFunc | string | ResourcesController)[], opts?: RegisterOptions): Layer | Layer[];
+  /**
+   * restful router api
+   * @param {String} name - Router name
+   * @param {String} prefix - url prefix
+   * @param {Function} middleware - middleware or controller
+   * @example
+   * ```js
+   * app.resources('/posts', 'posts')
+   * app.resources('posts', '/posts', 'posts')
+   * app.resources('posts', '/posts', app.role.can('user'), app.controller.posts)
+   * app.resources('posts', '/posts', middleware1, middleware2, app.controller.posts)
+   * ```
+   *
+   * Examples:
+   *
+   * ```js
+   * app.resources('/posts', 'posts')
+   * ```
+   *
+   * yield router mapping
+   *
+   * Method | Path            | Route Name     | Controller.Action
+   * -------|-----------------|----------------|-----------------------------
+   * GET    | /posts          | posts          | app.controller.posts.index
+   * GET    | /posts/new      | new_post       | app.controller.posts.new
+   * GET    | /posts/:id      | post           | app.controller.posts.show
+   * GET    | /posts/:id/edit | edit_post      | app.controller.posts.edit
+   * POST   | /posts          | posts          | app.controller.posts.create
+   * PATCH  | /posts/:id      | post           | app.controller.posts.update
+   * DELETE | /posts/:id      | post           | app.controller.posts.destroy
+   *
+   * app.router.url can generate url based on arguments
+   * ```js
+   * app.router.url('posts')
+   * => /posts
+   * app.router.url('post', { id: 1 })
+   * => /posts/1
+   * app.router.url('new_post')
+   * => /posts/new
+   * app.router.url('edit_post', { id: 1 })
+   * => /posts/1/edit
+   * ```
+   * @return {Router} return route object.
+   * @since 1.0.0
+   */
+  resources(prefix: string, controller: string | ResourcesController): Router;
+  resources(prefix: string, middleware: MiddlewareFunc, controller: string | ResourcesController): Router;
+  resources(name: string, prefix: string, controller: string | ResourcesController): Router;
+  resources(name: string, prefix: string, middleware: MiddlewareFunc, controller: string | ResourcesController): Router;
+  resources(nameOrPath: string | RegExp, ...middleware: (MiddlewareFunc | string | ResourcesController)[]): Router;
+  /**
+   * @param {String} name - Router name
+   * @param {Object} params - more parameters
+   * @example
+   * ```js
+   * router.url('edit_post', { id: 1, name: 'foo', page: 2 })
+   * => /posts/1/edit?name=foo&page=2
+   * router.url('posts', { name: 'foo&1', page: 2 })
+   * => /posts?name=foo%261&page=2
+   * ```
+   * @return {String} url by path name and query params.
+   * @since 1.0.0
+   */
+  url(name: string, params?: Record<string, string | number | (string | number)[]>): string;
+  /**
+   * @alias to url()
+   */
+  pathFor(name: string, params?: Record<string, string | number | (string | number)[]>): string;
+}
+//#endregion
+export { EggRouter };

package/dist/EggRouter.js

@@ -0,0 +1,208 @@
+import { Router } from "./Router.js";
+import assert from "node:assert";
+import { encodeURIComponent } from "utility";
+import inflection from "inflection";
+import methods from "methods";
+import { isGeneratorFunction } from "is-type-of";
+
+//#region src/EggRouter.ts
+const REST_MAP = {
+	index: {
+		suffix: "",
+		method: "GET"
+	},
+	new: {
+		namePrefix: "new_",
+		member: true,
+		suffix: "new",
+		method: "GET"
+	},
+	create: {
+		suffix: "",
+		method: "POST"
+	},
+	show: {
+		member: true,
+		suffix: ":id",
+		method: "GET"
+	},
+	edit: {
+		member: true,
+		namePrefix: "edit_",
+		suffix: ":id/edit",
+		method: "GET"
+	},
+	update: {
+		member: true,
+		namePrefix: "",
+		suffix: ":id",
+		method: ["PATCH", "PUT"]
+	},
+	destroy: {
+		member: true,
+		namePrefix: "destroy_",
+		suffix: ":id",
+		method: "DELETE"
+	}
+};
+/**
+* FIXME: move these patch into @eggjs/router
+*/
+var EggRouter = class extends Router {
+	app;
+	/**
+	* @class
+	* @param {Object} opts - Router options.
+	* @param {Application} app - Application object.
+	*/
+	constructor(opts, app) {
+		super(opts);
+		this.app = app;
+	}
+	verb(method, nameOrPath, pathOrMiddleware, ...middleware) {
+		const { path, middlewares, options } = this._formatRouteParams(nameOrPath, pathOrMiddleware, middleware);
+		if (typeof method === "string") method = [method];
+		this.register(path, method, middlewares, options);
+		return this;
+	}
+	head(nameOrPath, pathOrMiddleware, ...middlewares) {
+		return this.verb("head", nameOrPath, pathOrMiddleware, ...middlewares);
+	}
+	options(nameOrPath, pathOrMiddleware, ...middlewares) {
+		return this.verb("options", nameOrPath, pathOrMiddleware, ...middlewares);
+	}
+	get(nameOrPath, pathOrMiddleware, ...middlewares) {
+		return this.verb("get", nameOrPath, pathOrMiddleware, ...middlewares);
+	}
+	put(nameOrPath, pathOrMiddleware, ...middlewares) {
+		return this.verb("put", nameOrPath, pathOrMiddleware, ...middlewares);
+	}
+	patch(nameOrPath, pathOrMiddleware, ...middlewares) {
+		return this.verb("patch", nameOrPath, pathOrMiddleware, ...middlewares);
+	}
+	post(nameOrPath, pathOrMiddleware, ...middlewares) {
+		return this.verb("post", nameOrPath, pathOrMiddleware, ...middlewares);
+	}
+	delete(nameOrPath, pathOrMiddleware, ...middlewares) {
+		return this.verb("delete", nameOrPath, pathOrMiddleware, ...middlewares);
+	}
+	all(nameOrPath, pathOrMiddleware, ...middlewares) {
+		return this.verb(methods, nameOrPath, pathOrMiddleware, ...middlewares);
+	}
+	register(path, methods$1, middleware, opts) {
+		middleware = Array.isArray(middleware) ? middleware : [middleware];
+		for (const mw of middleware) if (isGeneratorFunction(mw)) throw new TypeError(methods$1.toString() + " `" + path + "`: Please use async function instead of generator function");
+		const middlewares = convertMiddlewares(middleware, this.app);
+		return super.register(path, methods$1, middlewares, opts);
+	}
+	resources(nameOrPath, pathOrMiddleware, ...middleware) {
+		const { path, middlewares, options } = this._formatRouteParams(nameOrPath, pathOrMiddleware, middleware);
+		const controller = resolveController(middlewares.pop(), this.app);
+		for (const key in REST_MAP) {
+			const action = controller[key];
+			if (!action) continue;
+			const opts = REST_MAP[key];
+			let routeName;
+			if (opts.member) routeName = inflection.singularize(options.name ?? "");
+			else routeName = inflection.pluralize(options.name ?? "");
+			if (opts.namePrefix) routeName = opts.namePrefix + routeName;
+			const prefix = path.replace(/\/$/, "");
+			const urlPath = opts.suffix ? `${prefix}/${opts.suffix}` : prefix;
+			const method = Array.isArray(opts.method) ? opts.method : [opts.method];
+			this.register(urlPath, method, middlewares.concat(action), { name: routeName });
+		}
+		return this;
+	}
+	/**
+	* @param {String} name - Router name
+	* @param {Object} params - more parameters
+	* @example
+	* ```js
+	* router.url('edit_post', { id: 1, name: 'foo', page: 2 })
+	* => /posts/1/edit?name=foo&page=2
+	* router.url('posts', { name: 'foo&1', page: 2 })
+	* => /posts?name=foo%261&page=2
+	* ```
+	* @return {String} url by path name and query params.
+	* @since 1.0.0
+	*/
+	url(name, params) {
+		const route = this.route(name);
+		if (!route) return "";
+		const args = params;
+		let url = route.path;
+		assert(!(url instanceof RegExp), `Can't get the url for regExp ${url} for by name '${name}'`);
+		const queries = [];
+		if (typeof args === "object" && args !== null) {
+			const replacedParams = [];
+			url = url.replace(/:([a-zA-Z_]\w*)/g, ($0, key) => {
+				if (key in args) {
+					const values = args[key];
+					replacedParams.push(key);
+					return encodeURIComponent(Array.isArray(values) ? String(values[0]) : String(values));
+				}
+				return $0;
+			});
+			for (const key in args) {
+				if (replacedParams.includes(key)) continue;
+				const values = args[key];
+				const encodedKey = encodeURIComponent(key);
+				if (Array.isArray(values)) for (const val of values) queries.push(`${encodedKey}=${encodeURIComponent(String(val))}`);
+				else queries.push(`${encodedKey}=${encodeURIComponent(String(values))}`);
+			}
+		}
+		if (queries.length > 0) {
+			const queryStr = queries.join("&");
+			if (!url.includes("?")) url = `${url}?${queryStr}`;
+			else url = `${url}&${queryStr}`;
+		}
+		return url;
+	}
+	/**
+	* @alias to url()
+	*/
+	pathFor(name, params) {
+		return this.url(name, params);
+	}
+};
+/**
+* resolve controller from string to function
+* @param {String|Function} controller input controller
+* @param {Application} app egg application instance
+*/
+function resolveController(controller, app) {
+	if (typeof controller === "string") {
+		const actions = controller.split(".");
+		let obj = app.controller;
+		actions.forEach((key) => {
+			obj = obj[key];
+			if (!obj) throw new Error(`app.controller.${controller} not exists`);
+		});
+		controller = obj;
+	}
+	if (!controller) throw new Error("controller not exists");
+	return controller;
+}
+/**
+* 1. ensure controller(last argument) support string
+* - [url, controller]: app.get('/home', 'home');
+* - [name, url, controller(string)]: app.get('posts', '/posts', 'posts.list');
+* - [name, url, controller]: app.get('posts', '/posts', app.controller.posts.list);
+* - [name, url(regexp), controller]: app.get('regRouter', /\/home\/index/, 'home.index');
+* - [name, url, middleware, [...], controller]: `app.get(/user/:id', hasLogin, canGetUser, 'user.show');`
+*
+* 2. bind ctx to controller `this`
+*
+* @param  {Array} middlewares middlewares and controller(last middleware)
+* @param  {Application} app  egg application instance
+*/
+function convertMiddlewares(middlewares, app) {
+	const controller = resolveController(middlewares.pop(), app);
+	function wrappedController(ctx, next) {
+		return controller.apply(ctx, [ctx, next]);
+	}
+	return [...middlewares, wrappedController];
+}
+
+//#endregion
+export { EggRouter };