InstallAdds 'smart plugin' support to your base application.
Install with npm:
$ npm install --save base-plugins
What does this do?
This plugin augments the generic plugin functionality that ships with base.
use
method and are only called once upon init.plugins
array, and can be called again later with the run
method.Examples .use examplevar plugins = require('base-plugins');
var Base = require('base');
var base = new Base();
Â
base.use(plugins());
Once the use
method is called:
fns
array is added to the instance for storing plugin functionsrun
method is added to the instance for running stored pluginsuse
method is modified so that anytime a function is returned by a plugin, the function will be pushed onto the fns
array. Aside from that, you shouldn't see any difference in how the use
method works.The run
method iterates over the fns
array and calls each stored plugin function on the given object.
API .usevar collection = {};
base.use(function(app)Â {
  app.x = 'y';
  return function(obj) {
    obj.a = 'b';
  };
});
base.run(collection);
Â
console.log(base.x);
console.log(collection.a);
Define a plugin function to be called immediately upon init. The only parameter exposed to the plugin is the application instance.
Also, if a plugin returns a function, the function will be pushed onto the fns
array, allowing the plugin to be called at a later point, elsewhere in the application.
Params
fn
{Function}: plugin function to callreturns
{Object}: Returns the item instance for chaining.Example
.runfunction foo(app) {
 Â
}
Â
var app = new Base()
  .use(foo)
  .use(bar)
  .use(baz)
Run all plugins
Params
value
{Object}: Object to be modified by plugins.returns
{Object}: Returns the item instance for chaining.Example
About Related projectsvar config = {};
app.run(config);
config
method for mapping declarative configuration values to other 'base⦠more | homepagedata
method to base-methods. | homepageoption
, enable
and disable
. See the readme⦠more | homepagePull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Building docs(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:
Running tests$ 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:
Author$ npm install && npm test
Jon Schlinkert
LicenseCopyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.4.3, on April 01, 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