Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inDemoInstall

yn

Package Overview
Dependencies
0
Maintainers
1
Versions
10
Issues
File Explorer

Advanced tools

yn

Parse yes/no like values

    5.0.0latest
    Github

Version published
Maintainers
1
Weekly downloads
17,545,167
increased by8.3%

Weekly downloads

Readme

Source

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, 'on', 'off'

Enable lenient mode to gracefully handle typos.

Install

$ npm install yn

Usage

import yn from '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

The 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

The default value if no match was found.

Keywords

FAQs

What is yn?

Parse yes/no like values

Is yn popular?

The npm package yn receives a total of 16,717,846 weekly downloads. As such, yn popularity was classified as popular.

Is yn well maintained?

We found that yn demonstrated a not healthy version release cadence and project activity because the last version was released a year ago.It has 1 open source maintainer collaborating on the project.

Last updated on 14 Aug 2021

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket[email protected]

Product

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc