@pirxpilot/router 1.0.0 → 1.1.0

package/HISTORY.md

@@ -1,4 +1,15 @@
 
+1.1.0 / 2025-01-18
+==================
+
+ * simplify layer creation
+ * remove `methods` dependency
+ * replace run-series with await/async
+ * allow using rawrequest with promises
+ * minor ES6 fixes
+ * minor improvement in Router.use
+ * use Set to keep track of route methods
+
 1.0.0 / 2024-12-31
 ==================
 

package/index.js

@@ -12,8 +12,8 @@
  * @private
  */
 
+const { METHODS } = require('node:http')
 const Layer = require('./lib/layer')
-const methods = require('methods')
 const parseUrl = require('parseurl')
 const Route = require('./lib/route')
 
@@ -375,9 +375,7 @@ Router.prototype.use = function use (handler, ...args) {
     throw new TypeError('argument handler is required')
   }
 
-  for (let i = 0; i < callbacks.length; i++) {
-    const fn = callbacks[i]
-
+  this.stack.push(...callbacks.map(fn => {
     if (typeof fn !== 'function') {
       throw new TypeError('argument handler must be a function')
     }
@@ -390,9 +388,8 @@ Router.prototype.use = function use (handler, ...args) {
     }, fn)
 
     layer.route = undefined
-
-    this.stack.push(layer)
-  }
+    return layer
+  }))
 
   return this
 }
@@ -430,13 +427,15 @@ Router.prototype.route = function route (path) {
 }
 
 // create Router#VERB functions
-methods.concat('all').forEach(function (method) {
-  Router.prototype[method] = function (path, ...args) {
-    const route = this.route(path)
-    route[method].apply(route, args)
-    return this
-  }
-})
+METHODS.concat('all')
+  .map(m => m.toLowerCase())
+  .forEach(method => {
+    Router.prototype[method] = function (path, ...args) {
+      const route = this.route(path)
+      route[method].apply(route, args)
+      return this
+    }
+  })
 
 /**
  * Generate a callback that will make an OPTIONS response.

package/lib/layer.js

@@ -28,20 +28,22 @@ const MATCHING_GROUP_REGEXP = /\((?:\?<(.*?)>)?(?!\?)/g
 
 module.exports = Layer
 
-function Layer (path, options, fn) {
-  if (!(this instanceof Layer)) {
-    return new Layer(path, options, fn)
+function Layer (path, opts = {}, fn, method) {
+  if (typeof fn !== 'function') {
+    throw new TypeError('argument handler must be a function')
   }
-
-  const opts = options || {}
-
   this.handle = fn
   this.keys = []
   this.name = fn.name || '<anonymous>'
   this.params = undefined
   this.path = undefined
   this.slash = path === '/' && opts.end === false
-  this.matchers = Array.isArray(path) ? path.map(p => matcher(p, opts)) : [matcher(path, opts)]
+  this.matchers = this.slash
+    ? []
+    : Array.isArray(path)
+      ? path.map(p => matcher(p, opts))
+      : [matcher(path, opts)]
+  this.method = method
 }
 
 function matcher (path, { sensitive, end, strict }) {
@@ -203,7 +205,7 @@ function decodeParam (val) {
     return decodeURIComponent(val)
   } catch (err) {
     if (err instanceof URIError) {
-      err.message = 'Failed to decode param \'' + val + '\''
+      err.message = `Failed to decode param '${val}'`
       err.status = 400
     }
 
@@ -220,6 +222,6 @@ function loosen (path) {
   }
 
   return Array.isArray(path)
-    ? path.map(function (p) { return loosen(p) })
+    ? path.map(p => loosen(p))
     : String(path).replace(TRAILING_SLASH_REGEXP, '')
 }

package/lib/route.js

@@ -12,8 +12,8 @@
  * @private
  */
 
+const { METHODS } = require('node:http')
 const Layer = require('./layer')
-const methods = require('methods')
 
 /**
  * Module variables.
@@ -38,7 +38,7 @@ function Route (path) {
   this.stack = []
 
   // route handlers for various http methods
-  this.methods = Object.create(null)
+  this.methods = new Set()
 }
 
 /**
@@ -50,16 +50,11 @@ Route.prototype._handlesMethod = function _handlesMethod (method) {
     return true
   }
 
-  // normalize name
-  let name = typeof method === 'string'
-    ? method.toLowerCase()
-    : method
-
-  if (name === 'head' && !this.methods.head) {
-    name = 'get'
+  if (method === 'HEAD' && !this.methods.has('HEAD')) {
+    method = 'GET'
   }
 
-  return Boolean(this.methods[name])
+  return this.methods.has(method)
 }
 
 /**
@@ -68,16 +63,11 @@ Route.prototype._handlesMethod = function _handlesMethod (method) {
  */
 
 Route.prototype._methods = function _methods () {
-  const methods = Object.keys(this.methods)
+  const methods = [...this.methods]
 
   // append automatic head
-  if (this.methods.get && !this.methods.head) {
-    methods.push('head')
-  }
-
-  for (let i = 0; i < methods.length; i++) {
-    // make upper case
-    methods[i] = methods[i].toUpperCase()
+  if (this.methods.has('GET') && !this.methods.has('HEAD')) {
+    methods.push('HEAD')
   }
 
   return methods
@@ -98,12 +88,9 @@ Route.prototype.dispatch = function dispatch (req, res, done) {
     return done()
   }
 
-  let method = typeof req.method === 'string'
-    ? req.method.toLowerCase()
-    : req.method
-
-  if (method === 'head' && !this.methods.head) {
-    method = 'get'
+  let { method } = req
+  if (method === 'HEAD' && !this.methods.has('HEAD')) {
+    method = 'GET'
   }
 
   req.route = this
@@ -193,43 +180,24 @@ Route.prototype.all = function all (...args) {
     throw new TypeError('argument handler is required')
   }
 
-  for (const fn of callbacks) {
-    if (typeof fn !== 'function') {
-      throw new TypeError('argument handler must be a function')
-    }
-
-    const layer = Layer('/', {}, fn)
-    layer.method = undefined
-
-    this.methods._all = true
-    this.stack.push(layer)
-  }
+  this.methods._all = true
+  this.stack.push(...callbacks.map(fn => new Layer('/', {}, fn)))
 
   return this
 }
 
-methods.forEach(function (method) {
-  Route.prototype[method] = function (...args) {
-    const callbacks = args.flat(Infinity)
-
-    if (callbacks.length === 0) {
-      throw new TypeError('argument handler is required')
-    }
-
-    for (let i = 0; i < callbacks.length; i++) {
-      const fn = callbacks[i]
+METHODS
+  .forEach(method => {
+    Route.prototype[method.toLowerCase()] = function (...args) {
+      const callbacks = args.flat(Infinity)
 
-      if (typeof fn !== 'function') {
-        throw new TypeError('argument handler must be a function')
+      if (callbacks.length === 0) {
+        throw new TypeError('argument handler is required')
       }
 
-      const layer = Layer('/', {}, fn)
-      layer.method = method
+      this.methods.add(method)
+      this.stack.push(...callbacks.map(fn => new Layer('/', {}, fn, method)))
 
-      this.methods[method] = true
-      this.stack.push(layer)
+      return this
     }
-
-    return this
-  }
-})
+  })

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pirxpilot/router",
   "description": "Simple middleware-style router",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "author": "Douglas Christopher Wilson <doug@somethingdoug.com>",
   "contributors": [
     "Blake Embrey <hello@blakeembrey.com>"
@@ -12,13 +12,11 @@
     "url": "git+https://github.com/pirxpilot/router.git"
   },
   "dependencies": {
-    "methods": "~1",
     "parseurl": "~1",
     "path-to-regexp": "~8"
   },
   "devDependencies": {
     "finalhandler": "~1",
-    "run-series": "~1",
     "standard": "~17",
     "supertest": "~7"
   },