base-is-enabled

0.1.0 • Public • Published

base-is-enabled NPM version Build Status

base application plugin to add an isEnabled method to the app

Install

Install with npm:

$ npm i base-is-enabled --save

Usage

Add base-is-enabled to an app.

var isEnabled = require('base-is-enabled');
var app.use(isEnabled());

Check if the verbose property is enabled. Returns true when verbose is true.

app.options.verbose = true;
console.log(app.isEnabled('verbose'));
//=> true

Returns false when verbose is false.

app.options.verbose = false;
console.log(app.isEnabled('verbose'));
//=> false

Use "falsey" patterns in the key path to toggle the results.

Returns false when verbose is true.

app.options.verbose = true;
console.log(app.isEnabled('not.verbose'));
//=> false

Returns true when verbose is false.

app.options.verbose = false;
console.log(app.isEnabled('not.verbose'));
//=> true

Related projects

  • falsey: Returns true if value is falsey. Works for strings, arrays and arguments objects with a… more | homepage
  • is-enabled: Using key paths that may contain "falsey" patterns, check if a property on an object… more | homepage

Generate docs

Generate readme and API documentation with [verb][]:

$ npm i -d && npm run docs

Or, if [verb][] is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Brian Woodward

License

Copyright © 2016 Brian Woodward Released under the MIT license.


This file was generated by verb, v0.1.0, on February 25, 2016.

Readme

Keywords

none

Package Sidebar

Install

npm i base-is-enabled

Weekly Downloads

135

Version

0.1.0

License

MIT

Last publish

Collaborators

  • doowb