2.0.0 • Published 9 years ago

@flexshopper/hapi-routes v2.0.0

Weekly downloads
12
License
ISC
Repository
github
Last release
9 years ago

@flexshopper/hapi-routes

Build Status Dependencies Dev dependencies

Plugin to autoload routes based on patterns.

How to use:

  • Install hapi-routes npm package in your project our plugin. npm i @flexshopper/hapi-routes
  • Register plugin in your hapi server:

Registering

const server = new Hapi.Server();

server.connection();

server.register({
    register: require('hapi-routes'),
    options: {
        relativeTo: proccess.cwd() + '/routes',
        includes: ['path/to/**/*routes.js'],
        ignore: ['*.git'],
    }
}, (err) => {
  // continue application
});

manifest style:

registrations: [
    ...
    {
        plugin: {
            register: 'hapi-routes',
            options: {
                relativeTo: proccess.cwd() + '/routes',
                includes: ['path/to/**/*routes.js'],
                ignore: ['*.git'],
            }
        }
    }
];

Options

includes

Required Type: array

The glob pattern you would like to include

ignore

Type: array

The pattern or an array of patterns to exclude

relativeTo

Type: string

The current working directory in which to search (defaults to process.cwd())

Route Signature

'use strict';

module.exports = (server) => {
    server.route([
        {
            method: 'GET',
            path: '/ping',
            config: {
                handler: (request, reply) => {
                    return reply({ status: 'OK' });
                }
            }
        }
    ]);
};
2.0.0

9 years ago

1.1.7

10 years ago

1.1.6

10 years ago

1.1.4

10 years ago

1.1.3

10 years ago

1.1.2

10 years ago

1.1.1

10 years ago

1.1.0

10 years ago

1.0.1

10 years ago

1.0.0

10 years ago