@koa/router 11.0.0 → 11.0.2

package/README.md

@@ -25,6 +25,7 @@
 * Express-style routing (`app.get`, `app.put`, `app.post`, etc.)
 * Named URL parameters
 * Named routes with URL generation
+* Match routes with specific host
 * Responds to `OPTIONS` requests with allowed methods
 * Support for `405 Method Not Allowed` and `501 Not Implemented`
 * Multiple route middleware

package/lib/router.js

@@ -5,15 +5,13 @@
  * @link https://github.com/alexmingoia/koa-router
  */
 
-const { debuglog } = require('util');
-
 const compose = require('koa-compose');
 const HttpError = require('http-errors');
 const methods = require('methods');
 const { pathToRegexp } = require('path-to-regexp');
 const Layer = require('./layer');
 
-const debug = debuglog('koa-router');
+const debug = require('debug')('koa-router');
 
 /**
  * @module koa-router
@@ -48,6 +46,7 @@ module.exports = Router;
  * @param {Object=} opts
  * @param {Boolean=false} opts.exclusive only run last matched route's controller when there are multiple matches
  * @param {String=} opts.prefix prefix router paths
+ * @param {String|RegExp=} opts.host host for router match
  * @constructor
  */
 
@@ -68,6 +67,7 @@ function Router(opts = {}) {
 
   this.params = {};
   this.stack = [];
+  this.host = this.opts.host;
 }
 
 /**
@@ -183,6 +183,24 @@ function Router(opts = {}) {
  * The [path-to-regexp](https://github.com/pillarjs/path-to-regexp) module is
  * used to convert paths to regular expressions.
  *
+ *
+ * ### Match host for each router instance
+ *
+ * ```javascript
+ * const router = new Router({
+ *    host: 'example.domain' // only match if request host exactly equal `example.domain`
+ * });
+ *
+ * ```
+ *
+ * OR host cloud be a regexp
+ *
+ * ```javascript
+ * const router = new Router({
+ *     host: /.*\.?example\.domain$/ // all host end with .example.domain would be matched
+ * });
+ * ```
+ *
  * @name get|put|post|patch|delete|del
  * @memberof module:koa-router.prototype
  * @param {String} path
@@ -358,6 +376,12 @@ Router.prototype.routes = Router.prototype.middleware = function () {
   const dispatch = function dispatch(ctx, next) {
     debug('%s %s', ctx.method, ctx.path);
 
+    const hostMatched = router.matchHost(ctx.host);
+
+    if (!hostMatched) {
+      return next();
+    }
+
     const path = router.opts.routerPath || ctx.routerPath || ctx.path;
     const matched = router.match(path, ctx.method);
     let layerChain;
@@ -735,6 +759,32 @@ Router.prototype.match = function (path, method) {
   return matched;
 };
 
+/**
+ * Match given `input` to allowed host
+ * @param {String} input
+ * @returns {boolean}
+ */
+
+Router.prototype.matchHost = function (input) {
+  const { host } = this;
+
+  if (!host) {
+    return true;
+  }
+
+  if (!input) {
+    return false;
+  }
+
+  if (typeof host === 'string') {
+    return input === host;
+  }
+
+  if (typeof host === 'object' && host instanceof RegExp) {
+    return host.test(input);
+  }
+};
+
 /**
  * Run middleware for named route parameters. Useful for auto-loading or
  * validation.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@koa/router",
   "description": "Router middleware for koa. Maintained by Forward Email and Lad.",
-  "version": "11.0.0",
+  "version": "11.0.2",
   "author": "Alex Mingoia <talk@alexmingoia.com>",
   "bugs": {
     "url": "https://github.com/koajs/router/issues",
@@ -12,6 +12,7 @@
     "@koajs"
   ],
   "dependencies": {
+    "debug": "^4.3.4",
     "http-errors": "^2.0.0",
     "koa-compose": "^4.1.0",
     "methods": "^1.1.2",