# kd-option-list

> ``` cli npm install kd-option-list ```

Latest version **1.0.1** (published 2023-02-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install kd-option-list
pnpm add kd-option-list
yarn add kd-option-list
bun add kd-option-list
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-02-03 |
| First published | 2023-02-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 17.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Alien chen |
| Maintainers | small-roach |
| Keywords | country, countries, kd-country-list |

## Links

- npm: https://www.npmjs.com/package/kd-option-list
- npm.io page: https://npm.io/package/kd-option-list

## Recent versions

- 1.0.1 (latest) — 2023-02-03

## README

# Install

``` cli
npm install kd-option-list
```


# kd-option-list
``` js
// 目前 选项列表有 国家 countries，证件类型cardTypes
const OptionList = require('kd-country-list');
const option = new OptionList('countries') // 这里填入对应的列表类型
console.log(option.getName('156')); // 中国
console.log(option.getCode('中国')); // 156
```

# 目前支持的方法有
### overwrite(items)

重写列表项目中的至

``` js
const OptionList = require('kd-country-list');
const option = new OptionList('countries') 
option.overwrite([{
  code: '156',
  name: '中国1'
}])
```

### getName(code)

通过代码code获取对应的name
``` js
// 目前 选项列表有 国家 countries，证件类型cardTypes
const OptionList = require('kd-country-list');
const option = new OptionList('countries') // 这里填入对应的列表类型
console.log(option.getName('156')); // 中国
```

### getCode(name)

通过name获取对应code
``` js
// 目前 选项列表有 国家 countries，证件类型cardTypes
const OptionList = require('kd-country-list');
const option = new OptionList('countries') // 这里填入对应的列表类型
console.log(option.getCode('中国')); // 156
```

### getNames()

获取所有选项的name
``` js
// 目前 选项列表有 国家 countries，证件类型cardTypes
const OptionList = require('kd-country-list');
const option = new OptionList('cardTypes') // 这里填入对应的列表类型
console.log(option.getNames()); // ['护照', '出生证明', '港澳通行证'...... ]
```

### getCodes()

获取所有选项的code
``` js
// 目前 选项列表有 国家 countries，证件类型cardTypes
const OptionList = require('kd-country-list');
const option = new OptionList('cardTypes') // 这里填入对应的列表类型
console.log(option.getCodes()); // ['1', '2', '3'...... ]
```

### getNameList()

返回name作为key ，code为属性名的所有选项的Object

### getCodeList()

返回code作为key，name作为属性名的所有选项的Object

### getData()

返回所有的选项信息，数据与json中定义的一致

---
_Source: https://npm.io/package/kd-option-list · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._