Git Product home page Git Product logo

hapi-glee's Introduction

Glee for Hapi

Don't want to show certain test routes on production? use Glee! Glee allows you to specify environment-specific scopes for your routes with ease. It utilizes minimatch to compare a route's optional scope to the current node environment, and will filter out any routes from the array that don't match the criteria before registering them.

Install

npm install glee

Example

If a route's scope is set to

!production

The route will be registered when the environment is not "production". Conversely, if the route's scope is set to

development

The route will only be registered if the environment is "development".

Advanced

Given the following scope:

+(development|staging)

The route will be registered if the environment is either "development", or "staging". You can read more about using minimatch here.

Usage

/**
 * Step 1. Define the routes.
 */
var routes = [
  {
    method: 'GET',
    path: '/',
    handler: function (request, reply) {
      return reply('Hello, World.\n');
    }
  }, {
    method: 'GET',
    path: '/ping',
    handler: function (request, reply) {
      return reply('Pong!\n');
    },
    config: {
      plugins: {
        glee: {
          // Register this route only if the environment
          // is not "production".
          scope: '!production'
        }
      }
    }
  }
];

/**
 * Step 2. Register the plugin.
 */
server.register([
  {
    register: require('glee'),
    options: {
      routes: routes,
      environment: 'development'
    }
  }
], function (err) {});
options
Name Type Description Required
routes array Our Hapi routes. Yes
environment string The server environment. This is what we will compare a route's scope to. Defaults to process.env.NODE_ENV No

Authors

License

MIT

hapi-glee's People

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  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.