node package manager

yn

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

Enable lenient mode to gracefully handle typos.

Install

$ npm install --save 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

Manage permissions for the whole team

Manage developer teams with varying permissions and multiple projects. Learn more about Private Packages and Organizations…

how? learn more

Collaborators list

Stats

Try it out

Keywords

yn, yes, no, cli, prompt, validate, input, answer, true, false, parse, lenient

Dependencies

None

Dependents (24)

fhir2, commodus, pull-prompt, footprint-node, ulong-ts-node, ts-node-warnings, corbel-composr, autopsy, @tradle/tim-server, positive, deploy-droid, picksel, dock-worker, @webdesignio/cli, @niik/ts-node, ts-node, brancher, @brad-jones/tsos, custom-ts-node, minecraft-manager, and more