yn (3.1.1)
Published 2026-02-24 14:09:03 +00:00 by atheaadmin
Installation
registry=npm install yn@3.1.1"yn": "3.1.1"About this package
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
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');
//=> 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
Dependencies
Development Dependencies
| ID | Version |
|---|---|
| ava | ^1.4.1 |
| tsd | ^0.7.2 |
| xo | ^0.24.0 |
Keywords
yn
yes
no
cli
prompt
validate
input
answer
true
false
parse
lenient