is-affirmative

v0.1.0
Returns true if a value is an `affirmative` value (from the affirmative lib). Useful for CLI prompts.
affirmative cli confirm inquirer prompt question truthy yes

is-affirmative NPM version Build Status

Returns true if a value is an affirmative value (from the affirmative lib). Useful for CLI prompts.

Install

Install with npm:

$ npm i is-affirmative --save

Usage

var isAffirmative = require('is-affirmative');

isAffirmative('yes');
//=> true

isAffirmative('no');
//=> false

See the [affirmative][] library for all supported values.

Examples

Returns true if the value is affirmative:

isAffirmative('yes');
isAffirmative('yeah');
isAffirmative('ok');
isAffirmative('okay');
isAffirmative('sure');
//=> true

Returns false if the value is not (anything but) an affirmative value:

isAffirmative('nope');
//=> false

Related projects

affirmative: Array of 'yes' words and phrases that express the user's agreement with a statement or… more | homepage

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

Jon Schlinkert

License

Copyright © 2016 Jon Schlinkert Released under the MIT license.


This file was generated by verb on January 19, 2016.

npm i is-affirmative

Metadata

  • MIT
  • >=0.10.0
  • Jon Schlinkert
  • released 1/19/2016

Downloads

Maintainers