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 = ; ;//=> true ;//=> false ;//=> true ;//=> undefined ;//=> false ;//=> 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.