View our GitHub

Please visit sails-docs on GitHub to view documentation on your mobile device.

Edit Page

.routes

The routes feature allows a custom hook to easily bind new routes to a Sails app at load time. If implemented, routes should be an object with either a before key, an after key, or both. The values of those keys should in turn be objects whose keys are route addresses, and whose values are route-handling functions with the standard (req, res, next) parameters. Any routes specified in the before object will be bound before custom user routes (as defined in sails.config.routes) and blueprint routes. Conversely, routes specified in the after object will be bound after custom and blueprint routes. For example, consider the following count-requests hook:

module.exports = function (sails) {

   return {

      initialize: function(cb) {
         this.numRequestsSeen = 0;
         this.numUnhandledRequestsSeen = 0;
         return cb();
      },

      routes: {
         before: {
            'GET /*': function (req, res, next) {
               this.numRequestsSeen++;
               return next();
            }
        },
        after: {
            'GET /*': function (req, res, next) {
               this.numUnhandledRequestsSeen++;
               return next();
            }
        }
    };
};

This hook will process all requests via the function provided in the before object, and increment its numRequestsSeen variable. It will also process any unhandled requests via the function provided in the after object—that is, any routes that aren't bound in the app via a custom route configuration or a blueprint.

The two variables set up in the hook will be available to other modules in the Sails app as sails.hooks["count-requests"].numRequestsSeen and sails.hooks["count-requests"].numUnhandledRequestsSeen

Is something missing?

If you notice something we've missed or could be improved on, please follow this link and submit a pull request to the sails-docs repo. Once we merge it, the changes will be reflected on the website the next time it is deployed.