@xmgift/pinyin

这是一个单个汉字转拼音库,支持读取韵母、音调,我编写这个库的目的:

Usage no npm install needed!

<script type="module">
  import xmgiftPinyin from 'https://cdn.skypack.dev/@xmgift/pinyin';
</script>

README

@xm/pinyin

这是一个单个汉字转拼音库,支持读取韵母、音调,我编写这个库的目的:

  • 方便读取韵母,结合其他库填词。填词需要有韵脚、平仄,当前库只支持韵脚,其他后续补充;
  • 语音合成的前期转换。一个汉字有很多读音,语音合成不应该基于汉字,起码应该基于读音,后续补充;

特别说明: 和这个库相关的其他库都以 @xm/ (也就是 "小明" 的拼音缩写)开头。

安装:

  yarn add @xm/pinyin

API

方法:getPinyin (character, style)

参数名称|说明|默认值| -|-|-| character|汉字,只支持单个|无| style|风格|0|

说明:style 可以是 0(有声调+无声调)、1(有声调)、2(无声调)

示例

有声调 + 无声调

  import Pinyin from '@xm/pinyin'
  console.log(Pinyin.getPinyin('丁'))

结果:

  {
    "withtone": [
      {
        "winthConsonant": "dīng",
        "noConsonant": "īng"
      },
      {
        "winthConsonant": "zhēng",
        "noConsonant": "ēng"
      }
    ],
    "notone": [
      {
        "winthConsonant": "ding",
        "noConsonant": "ing"
      },
      {
        "winthConsonant": "zheng",
        "noConsonant": "eng"
      }
    ]
  }

有声调

  import Pinyin from '@xm/pinyin'
  console.log(Pinyin.getPinyin('丁',1))

结果:

  [
    {
      "winthConsonant": "dīng",
      "noConsonant": "īng"
    },
    {
      "winthConsonant": "zhēng",
      "noConsonant": "ēng"
    }
  ]

无声调

  import Pinyin from '@xm/pinyin'
  console.log(Pinyin.getPinyin('丁',2))

结果:

  [
    {
      "winthConsonant": "ding",
      "noConsonant": "ing"
    },
    {
      "winthConsonant": "zheng",
      "noConsonant": "eng"
    }
  ]

Release

  • [2020/10/26] feature:基础版本,只支持单个汉字转拼音