resourceful-routes v1.1.0

Resourceful routes

A effortlessly express package to generate resourceful routes

Installation

npm install resourceful-routes

or

yarn add resourceful-routes

How to use

Import the package and pass your express router object as a param.

Example:

// routes.js

const router = require('express').Router();
require('resourceful-routes')(router, { debug: true });

router.resource('/users', UsersController, {
  except: ['show', 'destroy']
});
router.resource('contacts', ContactsController, {
  only: ['show'],
  paramName: 'contact_id'
})

Will mount the following routes:

Methods

# Constructor

constructor(router, options = {})

The initial setup for the package

# constructor params

# constructor options

# Resource

resource(path, controller, options = {})

Mount all the following routes, if not specified different in options

# resource params

# resource options

{
  only: [],
  except: [],
  paramName: ':id'
}