@ditojs/router 2.28.0 → 2.29.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ditojs/router",
-  "version": "2.28.0",
+  "version": "2.29.0",
   "type": "module",
   "description": "Dito.js Router – Dito.js is a declarative and modern web framework, based on Objection.js, Koa.js and Vue.js",
   "repository": "https://github.com/ditojs/dito/tree/master/packages/router",
@@ -21,7 +21,7 @@
     "node >= 18"
   ],
   "dependencies": {
-    "@ditojs/utils": "^2.28.0"
+    "@ditojs/utils": "^2.29.0"
   },
   "keywords": [
     "route",
@@ -30,6 +30,6 @@
     "koa",
     "dito"
   ],
-  "gitHead": "2bb631b6048da2d1dcb850d89796c87a4787b258",
+  "gitHead": "bdf4f66c3d6232f2322dacb088a0611f1e07dc7b",
   "readme": "# Dito.js Router\n\nDito.js is a declarative and modern web framework with a focus on API driven\ndevelopment, based on Koa.js, Objection.js and Vue.js\n\nReleased in 2018 under the MIT license, with support by https://lineto.com/\n\nDito.js Router is a high performance, tree-based, framework agnostic HTTP\nrouter, based on [trek-router](https://github.com/trekjs/router), which in turn\nis inspired by [Echo](https://github.com/labstack/echo)'s Router.\n\n## How does it work?\n\nThe router relies on a tree structure which makes heavy use of common\nprefixes, essentially a [prefix tree](https://en.wikipedia.org/wiki/Trie).\n\n## Usage\n\n```js\nimport Koa from 'koa'\nimport Router from '@ditojs/router'\n\nconst app = new Koa()\nconst router = new Router()\n\n// static route\nrouter.get('/folders/files/bolt.gif', ctx => {\n  ctx.body = `this ain't no GIF!`\n})\n\n// param route\nrouter.get('/users/:id', ctx => {\n  ctx.body = `requesting user ${ctx.params.id}`\n})\n\n// match-any route\nrouter.get('/books/*', ctx => {\n  ctx.body = `sub-route: ${ctx.params['*']}`\n})\n\n// Handler found\nlet { handler, params } = router.find('get', '/users/233')\nconsole.log(handler) // ctx => { ... }\n\n// Entry not Found\nlet { handler, params } = router.find('get', '/photos/233')\nconsole.log(handler) // null\n\n// Install router middleware\napp.use(async (ctx, next) => {\n  const { method, path } = ctx\n  const result = router.find(method, path)\n  const { handler, params } = result\n  if (handler) {\n    ctx.params = params || {}\n    return handler(ctx, next)\n  } else {\n    try {\n      await next()\n    } finally {\n      if (ctx.body === undefined && ctx.status === 404) {\n        ctx.status = result.status || 404\n        if (ctx.status !== 404 && result.allowed) {\n          ctx.set('Allow', result.allowed.join(', '))\n        }\n      }\n    }\n  }\n})\n\napp.listen(4040, () => console.log('Koa app listening on 4040'))\n```\n"
 }

package/src/Node.js

@@ -67,7 +67,7 @@ export default class Node {
         const start = pos
         // Move pos to the next occurrence of the slash or the end:
         pos += path.slice(pos).match(/^([^/]*)/)[1].length
-        parameters.add(
+        parameters.addKey(
           isWildcard ? parameters.getPlaceholderKey() : path.slice(start, pos)
         )
         // Chop out param name from path, but keep colon.
@@ -242,7 +242,7 @@ class Parameters {
     this.placeholderIndex = 0
   }
 
-  add(key) {
+  addKey(key) {
     this.keys.push(key)
   }
 
@@ -271,15 +271,15 @@ class Parameters {
       if (token === '**') {
         const key = this.getMatchAnyKey()
         pattern.push(`(?<${key}>.+?)`)
-        this.add(key)
+        this.addKey(key)
       } else if (token === '*') {
         const key = this.getPlaceholderKey()
         pattern.push(`(?<${key}>[^/]+)`)
-        this.add(key)
+        this.addKey(key)
       } else if (token.startsWith(':')) {
         const key = token.slice(1)
         pattern.push(`(?<${key}>[^/]+)`)
-        this.add(key)
+        this.addKey(key)
       } else {
         pattern.push(token)
       }