Giter Club home page Giter Club logo

hapi-peel's Introduction

Peel travis npm

Peel is a simple library to help with testing and development of modular plugin based Hapi servers. It simply checks if your module is being required (by checking module.parent). If your module is not being required, it will create a Hapi server, register your plugin module, and pass back the server object for you to start the server with.

Peel fully expects you follow the Hapi plugin interface conventions. This allows you to use your plugin module as a true plugin or directly with Peel.

Install

npm install hapi-peel

API

The only special behavior that exists if if you choose not to pass in a callback to Peel.create, which will auto start the Hapi server. Otherwise you have full control over when the server starts.

var Peel = require('hapi-peel');

// Hapi plugin config
// exports.register = function () {}

Peel.create(module, {
  port: 8080
});

Peel.create(module, config, [callback])

Creates Hapi server if not required, otherwise calls back with no server.

module is required, as well as config.

config approximates Hapi's server arguments host, port, options:

  • host - optional
  • port - optional
  • config - optional

License

MIT

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.