@nahanil/zhdict-lite/README.md

Access extended CC-CEDICT dictionary data

## @nahanil/zhdict-lite
[![pipeline status](https://git.carrotlabs.net/zhdict/zhdict-lite/badges/master/pipeline.svg)](https://git.carrotlabs.net/zhdict/zhdict-lite/pipelines)
[![coverage report](https://git.carrotlabs.net/zhdict/zhdict-lite/badges/master/coverage.svg)](http://zhdict.pages.carrotlabs.net/zhdict-lite/coverage/)
[![NPM version](https://badge.fury.io/js/@nahanil%2Fzhdict-lite.svg)](https://www.npmjs.com/package/@nahanil/zhdict-lite)

Fallback data source for [zhdict.net](https://zhdict.net/)

```bash
npm install --save @nahanil/zhdict-lite
# OR
yarn add @nahanil/zhdict-lite
```

```js
const dict = require('@nahanil/zhdict-lite')
```

### Search for a word or character
```js
let results = await dict.search('水')
/*
 * Always returns an array of results
  [
    {
      "id": "3f69904700c4fe2fb2caeb3f46501bc66ce245a4",
      "simplified": "水",
      "traditional": "水",
      "pinyin": "shui3",
      "hskLevel": 1,
      "english": "surname Shui/water/river/...",
      "radicalSimplified": "水",
      "radicalTraditional": "水",
      "strokesSimplified": 4,
      "strokesTraditional": 4,
      "strokesMinRadSimplified": 0,
      "strokesMinRadTraditional": 0,
      "variantsSimplified": null,
      "variantsTraditional": null,
      "variants": "氵"
    }
  ]
*/

let results = await dict.search('你好')
/*
  [
    {
      id: 'd3e4b9c5d696fe124825709a9a73aa3f01c61b2a',
      simplified: '你好',
      traditional: '你好',
      pinyin: 'ni3 hao3',
      english: 'hello/hi',
      hskLevel: null,
      radicalSimplified: null,
      radicalTraditional: null,
      strokesSimplified: null,
      strokesTraditional: null,
      strokesMinRadSimplified: null,
      strokesMinRadTraditional: null,
      variantsSimplified: null,
      variantsTraditional: null,
      variants: null
    }
  ]
*/
```

### Search for a word or character by radical
```js
let results = await dict.searchByRadical('水')
/*
 * Always returns an array of results
  [
    {
      "id": "3f69904700c4fe2fb2caeb3f46501bc66ce245a4",
      "simplified": "水",
      "traditional": "水",
      "pinyin": "shui3",
      "english": "surname Shui/water/river/liquid/beverage/...",
      "radicalSimplified": "水",
      "radicalTraditional": "水",
      "strokesSimplified": 4,
      "strokesTraditional": 4,
      "strokesMinRadSimplified": 0,
      "strokesMinRadTraditional": 0,
      "variantsSimplified": null,
      "variantsTraditional": null,
      "variants": "氵"
    },
    // ...
  ]
*/
```

### See also
- [parser.md](./parser.md)
- [CC-CEDICT download](https://www.mdbg.net/chinese/dictionary?page=cedict)