JSPM

  • Created
  • Published
  • Downloads 16
  • Score
    100M100P100Q72625F
  • License ISC

Node wrapper for the MDBG database

Package Exports

  • mdbg

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (mdbg) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

MDBG

npm version Travis Build Status dependency status dev dependency status ISC-licensed

Install

npm install mdbg

Usage

const mdbg = require('mdbg')

mdbg.get('苹果') // mdbg.getByHanzi('苹果')
.then(console.log)
// {
//   "traditional": "蘋果",
//   "simplified": "苹果",
//   "definitions": {
//     ping2 guo3": {
//       "pinyin": "píng guǒ",
//       "zhuyin": "ㄆㄧㄥˊㄍㄨㄛˇ",
//       "translations": [
//         "apple"
//       ],
//       "classifiers": {
//         "ge4": {
//           "traditional": "個",
//           "simplified": "个",
//           "pinyin": "gè"
//         },
//         "ke1": {
//           "traditional": "顆",
//           "simplified": "颗",
//           "pinyin": "kē"
//         }
//       }
//     }
//   }
// }

mdbg.get('吗') // mdbg.getByHanzi('吗')
.then(console.log)
// {
//   "traditional": "嗎",
//   "simplified": "吗",
//   "definitions": {
//     "ma3": {
//       "pinyin": "mǎ",
//       "zhuyin": "ㄇㄚˇ",
//       "translations": [
//         "see 嗎啡|吗啡, morphine"
//       ]
//     },
//     "ma5": {
//       "pinyin": "ma",
//       "zhuyin": "ㄇㄚ˙",
//       "translations": [
//         "(question particle for \"yes-no\" questions)"
//       ]
//     }
//   }
// }

mdbg.get('wo3') // mdbg.getByPinyin('wo3')
.then(console.log)
// [
//   {
//     "traditional": "我",
//     "simplified": "我",
//     "definitions": {
//       "wo3": {
//         "pinyin": "wǒ",
//         "zhuyin": "ㄨㄛˇ",
//         "translations": [
//           "I",
//           "me",
//           "my"
//         ]
//       }
//     }
//   },
//   {
//     "traditional": "婐",
//     "simplified": "婐",
//     "definitions": {
//       "wo3": {
//         "pinyin": "wǒ",
//         "zhuyin": "ㄨㄛˇ",
//         "translations": [
//           "maid"
//         ]
//       }
//     }
//   }
// ]

mdbg.get('ㄒㄧˇㄏㄨㄢ˙') // mdbg.getByZhuyin('ㄒㄧˇㄏㄨㄢ˙')
// .then(console.log)
// [
//   {
//     "traditional": "喜歡",
//     "simplified": "喜欢",
//     "definitions": {
//       "xi3 huan5": {
//         "pinyin": "xǐ huan",
//         "zhuyin": "ㄒㄧˇㄏㄨㄢ˙",
//         "translations": [
//           "to like",
//           "to be fond of"
//         ]
//       }
//     }
//   }
// ]

mdbg.getIndexByPinyin('shui3')
.then(console.log)
// [ "水", "氵", "氺" ]

mdbg.getIndexByZhuyin('ㄍㄨㄛˇ')
.then(console.log)
// [ "惈", "槨", "猓", "粿", "菓", "蜾", "裹", "輠", "餜" ]

Contributing

If you have a question, found a bug or want to propose a feature, have a look at the issues page.