en-route

Routing for static site generators, build systems and task runners, heavily based on express.js routes but works with file objects. Used by Assemble, Verb, and Template.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

Install

Install with npm:

$ npm install --save en-route

API

Layer

Create a new Layer with the given pattern, handler function and options.

Params

• pattern {string}
• handler {function}
• options {object}

Example

const layer = new Layer('/', file => {
  // do stuff to file
  file.extname = '.html';
});

.handle

Calls the layer handler on the given file if the file.path matches the layer pattern.

Params

• file {object}: File object
• returns {Promise}

Example

layer.handle(file)
  .then(() => console.log('Done:', file))
  .then(console.error)

.match

Attempts to match a file path with the layer pattern. If the path matches, an object of params is returned (see path-to-regexp for details), otherwise null is returned.

Params

• filepath {string}
• returns {object|null}

Example

const layer = new Layer('/:name');
console.log(layer.match('/foo')) //=> { name: 'foo' }

Route

Create a new Route with the given pattern, handler functions and options.

Params

• pattern {string|regex}
• fns {function|array}: One or more middleware functions.
• options {object}

Example

const fn = file => file.count++;
const Route = require('en-route').Route;
const route = new Route('/(.*)', [fn, fn, fn]);
const file = { path: '/foo', count: 0 };

route.handle(file)
  .then(file => {
    console.log(file.count); // 3
  });

.all

Register a handler to be called on all layers on the route.

Params

• fn {function}: Handler function
• returns {object}: Route instance for chaining

Example

route.all(file => {
  file.data.title = 'Home';
});

.handle

Run a middleware stack on the given file.

Params

• file {object}: File object
• returns {object}: Callback that exposes err and file
• returns {object}: Returns a promise with the file object.

Example

route.handle(file)
  .then()

.layer

Push a layer onto the stack for a middleware functions.

Params

• pattern {string|regex}: The pattern to use for matching files to determin if they should be handled.
• fn {function|array}: Middleware functions
• returns {object}: Route instance for chaining

Example

route.layer(/foo/, file => {
  // do stuff to file
  file.layout = 'default';
});

.layers

Push a layer onto the stack for one or more middleware functions.

Params

• pattern {string|regex}
• fns {function|array}: One or more middleware functions
• returns {object}: Route instance for chaining

Example

route.layers(/foo/, function);
route.layers(/bar/, [function, function]);

Route

Create a new Router with the given options.

Params

• options {object}

Example

const route = new Router({ handlers: ['preWrite', 'postWrite']});

.handler

Create a middleware handler method.

Params

• method {string}: Method name
• options {object}
• returns {object}: Returns the instance for chaining.

.route

Create a new router instance with all handler methods bound to the given pattern.

Params

• pattern {string}
• returns {object}: Returns a new router instance with handler methods bound to the given pattern.

Example

const router = new Router({ handlers: ['before', 'after'] });
const file = { path: '/foo', content: '' };

router.route('/foo')
  .before(function(file) {
    file.content += 'foo';
  })
  .after(function(file) {
    file.content += 'bar';
  });

router.handle(file)
  .then(() => {
    assert.equal(file.content, 'foobar');
  });

.handlers

Add one or more middleware handler methods. Handler methods may also be added by passing an array of handler names to the constructor on the handlers option.

Params

• methods {string}: Method names
• options {object}
• returns {object}: Returns the instance for chaining.

Example

router.handlers(['onLoad', 'preRender']);

.handle

Run a middleware methods on the given file.

Params

• method {string|file}: The handler method to call on file. If the first argument is a file object, all handlers will be called on the file.
• file {object}: File object
• returns {Promise}

Example

// run a specific method
router.handle('onLoad', file)
  .then(file => console.log('File:', file))
  .catch(console.error);

// run multiple methods
router.handle('onLoad', file)
  .then(file => router.handle('preRender', file))
  .catch(console.error);

// run all methods
router.handle(file)
  .then(file => console.log('File:', file))
  .catch(console.error);

.all

Register all handler methods on the given file.

Params

• file {object}: File object
• returns {Promise}

Example

router.all(file => {
  file.data.title = 'Home';
});

.mixin

Mix router methods onto the given object.

Params

• target {object}
• returns {undefined}

Example

const router = new Router();
const obj = {};
router.handlers(['before', 'after']);
router.mixin(obj);
console.log(obj.before) //=> [function]

Release history

v2.0.0

Breaking changes

• en-route was completely refactored from the ground-up.

v1.0.0

Breaking changes

• en-route no longer supports error middleware (middleware with three arguments). This was done to simplify debugging, eliminate code debt that makes en-route harder to maintain and improve, to make en-route and middleware run faster, and to make certain that errors are always passed to the final done function.

About

$ npm install && npm test

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

• assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
• base-routes: Plugin for adding routes support to your base application. Requires templates support to work. | homepage
• base: Framework for rapidly creating high quality, server-side node.js applications, using plugins like building blocks | homepage
• gulp-routes: Add middleware to run for specified routes in your gulp pipeline. | homepage

Contributors

Author

Brian Woodward

• LinkedIn Profile
• GitHub Profile
• Twitter Profile

Jon Schlinkert

• LinkedIn Profile
• GitHub Profile
• Twitter Profile

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on March 21, 2018.