Giter VIP home page Giter VIP logo

booting's Introduction

booting

A simple async and parallel booting sequence for your applications. It provides you with a clean structure to setup and configure you application. Because the more stuff you need to do during boot, the deeper you callback xmas tree will become and the less maintainable the code base becomes.

Installation

The package is released to our public npm registry.

npm install --save booting

Usage

var booting = require('booting');

The exposed booting function takes a single argument which is the data or state that can be passed around to all your booting layers:

var app = require('your app instance');
var boot = booting(app);

The function returns an object that contains the following methods:

  • use A function to introduce a new boot sequence. The boot sequence should be a function that receives two arguments:
    1. The data that you passed in to the booting function
    2. Error first completion callback for when your task is finished executing.
  • start Completion callback for when your boot sequences that your added using use are completed. The callback receives two arguments:
    1. Option error for when a boot sequence failed.
    2. The data that you passed in to the booting function.

So setting up a boot sequence would be as easy as:

var booting = require('booting');
var app = require('./app');

booting(app)
.use(require('./preboot/config'))
.use(require('./preboot/database'))
.use(require('./preboot/server'))
.use(require('./preboot/phonehome'))
.start(function (err, app) {
  app.start();
})

License

MIT

booting's People

Contributors

3rd-eden avatar

Stargazers

 avatar  avatar

Watchers

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