Wrapper around is-valid-instance and is-registered for validating
base
plugins. Returns true ifapp
is a valid instance of base and a plugin is not registered yet.
Install with npm:
$ npm install --save is-valid-app
var isValid = require('is-valid-app');
// in your Base plugin
function plugin(app) {
// plugin name is required as the second argument
if (!isValid(app, 'my-plugin')) return;
// do plugin stuff
}
Optionally pass an array of instance types as the third argument:
function plugin(app) {
if (!isValid(app, 'my-plugin', ['view', 'collection'])) return;
// do plugin stuff
}
Visit base for more details.
v0.3.0
- upgrades is-valid-instance to v0.3.0, which adds support for checking
app.type
for the instance type. We don't expect any regressions, but if you experience one, please create an issue.
- base: base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… more | homepage
- is-registered: Util for Base that optionally prevents a plugin from being registered more than once on… more | homepage
- is-valid-instance: Returns true if a value is a valid instance of Base. | homepage
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Commits | Contributor |
---|---|
10 | jonschlinkert |
3 | doowb |
(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.4.3, on March 24, 2017.