# yn

**Repository Path**: ArkTSCentralRepository/yn

## Basic Information

- **Project Name**: yn
- **Description**: yn 是一个用于解析类似“yes/no”的值的库，支持处理多种形式的用户输入，如 'y', 'yes', 'no', 'true' 等，并可以通过选项灵活处理拼写错误。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-11-21
- **Last Updated**: 2024-11-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# yn

基于[yn](https://www.npmjs.com/package/yn)原库5.0.0版本进行适配，所有功能代码已经转换为`ArkTS`文件

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

*Enable lenient mode to gracefully handle typos.*

## Install

```shell
ohpm install yn
```

## Usage

```js
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.