@flexshopper/hapi-routes

@flexshopper/hapi-routes

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' });
                }
            }
        }
    ]);
};