Orchestrate multiple instances of base at once.
Install with npm:
$ npm install --save base-runner
var runner = require('base-runner'); var Base = require('base'); runner(Base, options, argv, function(err, app, runnerContext) { // `err`: error object, if an error occurred // `app`: instance of `base` // `runnerContext`: object with `argv`, `env` and `options` properties });
Params
Base
- (required) base constructoroptions
- (required) configuration optionsargv
- (required) parsed process.argv
object from minimist or whatever argv parser you prefer.var runner = require('base-runner'); var Base = require('base'); var config = { name: 'awesome', cwd: process.cwd(), runner: require('./package.json'), processTitle: 'awesome', moduleName: 'awesome', extensions: { '.js': null } }; runner(Base, options, argv, function(err, app, runnerContext) { // `err`: error object, if an error occurred // `app`: instance of `base` // `runnerContext`: object with `argv`, `env` and `options` properties });
Create a runner
with the given constructor
, liftoff config
object, argv
object and callback
function.
Params
Ctor
{Function}: Constructor to use, must inherit base.config
{Object}: The config object to pass to liftoff.argv
{Object}: Argv object, optionally pre-parsed.cb
{Function}: Callback function, which exposes err
, app
(base application instance) and runnerContext
returns
{Object}Example
var Base = require('base'); var argv = require('minimist')(process.argv.slice(2)); var config = { name: 'foo', cwd: process.cwd(), extensions: {'.js': null} }; runner(Base, config, argv, function(err, app, runnerContext) { if (err) throw err; // do stuff with `app` and `runnerContext` process.exit(); });
The following constructor events are emitted:
Exposes runnerContext
as the only paramter.
Base.on('preInit', function(runnerContext) { });
Exposes runnerContext
and app
(the application instance) as paramters.
Base.on('init', function(runnerContext, app) { });
Exposes runnerContext
and app
(the application instance) as paramters.
Base.on('postInit', function(runnerContext, app) { });
Exposes runnerContext
and app
(the application instance) as paramters.
Base.on('finished', function(runnerContext, app) { });
base
application. | homepageoption
, enable
and disable
. See the readme… more | homepagePull requests and stars are always welcome. For bugs and feature requests, please create an issue.
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
Jon Schlinkert
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on July 18, 2017.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4