sindresorhus / Yn
Licence: mit
Parse yes/no like values
Stars: ✭ 203
Programming Languages
javascript
184084 projects - #8 most used programming language
yn
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, 'on', 'off'
Enable lenient mode to gracefully handle typos.
Install
$ npm install yn
Usage
const yn = require('yn');
yn('y');
//=> true
yn('NO');
//=> false
yn(true);
//=> true
yn('abomasum');
//=> undefined
yn('abomasum', {default: false});
//=> false
yn('mo', {lenient: true});
//=> false
Unrecognized values return undefined.
API
yn(input, options?)
input
Type: unknown
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: undefined
Default value if no match was found.
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].