Code Monkey home page Code Monkey logo

hapijs-namespace's Introduction

hapijs-namespace

Build Status Coverage Status

This library makes it easy to namespace your routes with a set prefix. It takes in an array of native hapi routes and once prefixed they are applied directly to the server object removing the need to write any additional code.

Install

Install through npm:

npm install --save hapijs-namespace

Usage

namespace(server, prefix, routes)

server is a hapi server object to which you want to add the routes

prefix is the namespace prefix

routes is an array of hapi routes

The routes are namespaced and applied to the server object.

Quick Start

See example for more complete example usage including multiple routes, recommended file structure, and an index route.

Call namespace function passing the server object, prefix, and routes and the routes will be prefixed and added to the server object.

const namespace = require('namespace');

const server = new Hapi.Server(...);

namespace(server, '/healthcheck', [
    {
        method: 'GET',
        path: '/ping',
        config: {
            description: 'Simple healthcheck route',
            notes: ['Should return status 200 with a simple object'],
            tags: ['api', 'healthcheck'],
            handler: HealthCheckController.ping,
        },
    },
]);

Testing

Simply run npm test to run the tests

hapijs-namespace's People

Contributors

twgibbons avatar

Stargazers

Nikolay Lebedev avatar Zack Allison avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.