Popularity
2.8
Growing
Activity
1.0
Growing
202
8
16

Monthly Downloads: 0
Programming language: JavaScript
License: MIT License
Tags: Command Line Utilities     Validate     Parse     CLI     Prompt     Input     Lenient     False     True     Answer     No     Yes     Yn    
Latest version: v4.0.0

yn alternatives and similar modules

Based on the "Command Line Utilities" category.
Alternatively, view yn alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of yn or a related project?

Add another 'Command Line Utilities' Module

README

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.