# yn

> Parse yes/no like values

Useful for validating answers of a CLI prompt.

***

The following case-insensitive values are recognized:

```js
'y', 'yes', 'true', true, '1', 1, 'n', 'no', 'false', false, '0', 0
```

*Enable lenient mode to gracefully handle typos.*

## Install

```
$ npm install yn
```

## Usage

```js
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](https://sindresorhus.com)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://civictech-ou.gitbook.io/nova-docs/use-cases/node_modules/yn.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.