npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

yocto-router

v2.0.1

Published

Manage route configuration & mapping for an express app

Downloads

22

Readme

NPM

alt text Code Climate Test Coverage Issue Count Build Status

Overview

This module is a part of yocto node modules for NodeJS.

Please see our NPM repository for complete list of available tools (completed day after day).

This module manage routes configuration & mapping for an express app.

Motivation

Create a simple and ready to use router manager from a json file configuration.

How to use

var logger    = require('yocto-logger');
var r         = require('yocto-router')(logger);
var express   = require('express');

var app = express();
// set path into app
r.useApp(app);
// set routes path
r.setRoutes('./example/routes/');
// set controller endpoint
r.setEndPoint('./example/ctrl/'); 
// process configure
if (!r.configure()) {
  // error
} else {
  // your valid process here
}

Routes Json configuration files syntax

Your json configuration for routes must be follow these syntax :

[
  {
    "method"  : "YOUR_VALID_HTTP_METHOD_NAME_HERE",
    "path"    : "YOUR_ROUTE_PATTERN_HERE",
    "regexp"  : "true|false", // Eval string as a regexp or not
    "priority" : 100, // Defined your priority order on route definition into express
    "controller" : {
      "name"  : "YOUR_CONTROLLER_NAME_HERE",
      "fn"  : "YOUR_CONTROLLER_FN_NAME_HERE"
    }
  }
]

See Below an example :

[
  {
    "method"  : "post",
    "path"    : "/foo/bar",
    "controller" : {
      "name"  : "controllerFoo",
      "fn"  : "methodBar"
    }
  }  
]

Routes for 404 and 500 HTTP codes

You can also defined route process for 404 and 500 HTTP code, just follow config example below :

[
  {
    "error" : 404 | 500 // with code you want
    "priority" : 100, // Defined your priority order on route definition into express very important
    "controller" : {
      "name"  : "YOUR_CONTROLLER_NAME_HERE",
      "fn"  : "YOUR_CONTROLLER_FN_NAME_HERE"
    }
  }
]

Into your controller just follow the express syntax for error middleware process.

You can find here the Express FAQ for more details

Controller Javascript files syntax

If you are here, it's because you have already define a least one route.

So controller syntax is a same than express export syntax.

exports.methodBar = function(req, res, next) {
  // your code here
};

Context in your controller enpoint

In your controller endpoint you can use this keywords to access on your express app

Logging in tool

By Default this module include yocto-logger for logging. It's possible to inject in your router instance your current logger instance if is another yocto-logger instance.

For example :

var logger = require('yocto-logger');
// EXTRA CODE HERE FOR YOUR APP
// AGAIN & AGAIN
var router = require('yocto-router')(logger);

Changelog

All history is here