Get unlimited public & private packages + team-based management with npm Teams.Learn more »

yn

4.0.0 • Public • Published

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, '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.

Install

npm i yn

DownloadsWeekly Downloads

3,198,447

Version

4.0.0

License

MIT

Unpacked Size

5.89 kB

Total Files

6

Last publish

Collaborators

  • avatar