Parse yes/no like values
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.editorconfig Meta tweaks May 12, 2017
.gitattributes Meta tweaks May 12, 2017
.gitignore init Aug 6, 2014
.travis.yml ES2015ify (#14) May 12, 2017
index.js ES2015ify (#14) May 12, 2017
lenient.js ES2015ify (#14) May 12, 2017
license init Aug 6, 2014
package.json 2.0.0 May 12, 2017
readme.md Fix GitHub Markdown rendering changes (#16) Jan 21, 2018
test.js Meta tweaks May 12, 2017

readme.md

yn Build Status

Parse yes/no like values

Useful for validating answers of a CLI prompt.


The following case-insensitive values are recognized:

'y', 'yes', 'true', true, '1', 1, 'n', 'no', 'false', false, '0', 0

Enable lenient mode to gracefully handle typos.

Install

$ npm install --save yn

Usage

const yn = require('yn');

yn('y');
//=> true

yn('NO');
//=> false

yn(true);
//=> true

yn('abomasum');
//=> null

yn('abomasum', {default: false});
//=> false

yn('mo', {lenient: true});
//=> false

Unrecognized values return null.

API

yn(input, [options])

input

Type: any

Value that should be converted.

options

Type: object

lenient

Type: boolean
Default: false

Use a key distance-based score to leniently accept typos of yes and no.

default

Type: boolean
Default: null

Default value if no match was found.

License

MIT © Sindre Sorhus