peach a19a732be8 commit message | 2 年之前 | |
---|---|---|
.. | ||
index.d.ts | 2 年之前 | |
index.js | 2 年之前 | |
lenient.js | 2 年之前 | |
license | 2 年之前 | |
package.json | 2 年之前 | |
readme.md | 2 年之前 |
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.
$ npm install yn
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
.
Type: any
Value that should be converted.
Type: Object
Type: boolean
Default: false
Use a key distance-based score to leniently accept typos of yes
and no
.
Type: boolean
Default: null
Default value if no match was found.
MIT © Sindre Sorhus