Pinyin Match Hanzi - 拼音匹配汉字工具库

English Documentation

安装

npm install pinyin-match-hanzi

使用方法

基本使用

import { 
  getPinyinCandidates, 
  getBestCandidates, 
  convertPinyinToChinese, 
  segmentAndConvert,
  segmentPinyin,
  split
} from 'pinyin-match-hanzi'

// 获取拼音对应的候选词
const candidates = getPinyinCandidates('nihao');
console.log(candidates); // [{ w: '你好', f: 1234, matchLength: 4 }, ...]

// 获取最佳候选词
const best = getBestCandidates('woshizhongguoren', 3);
console.log(best); // 返回前3个最佳候选词

// 转换拼音为中文
const chinese = convertPinyinToChinese('woaini');
console.log(chinese); // '我爱你'

// 分词转换
const converted = segmentAndConvert('wo ai shanghai');
console.log(converted); // 尝试转换混合拼音文本

// 分词拼音 - 将连续的拼音分解成带单引号分隔的拼音
const segmented = segmentPinyin('pinyinshurufa');
console.log(segmented); // 'pin'yin'shu'ru'fa' 或类似的分词结果

// 原始分词功能 - 获取详细的分词结果
const splitResult = split('pinyinshurufa');
console.log(splitResult); // 返回包含分词数组和校正结果的对象

API 说明

getPinyinCandidates(pinyin: string)

根据拼音获取所有可能的候选词。

getBestCandidates(pinyin: string, count: number = 1)

获取指定数量的最佳候选词。

convertPinyinToChinese(pinyin: string, index: number = 0)

将拼音转换为中文，index 参数指定选择第几个候选词（从0开始）。

segmentAndConvert(text: string)

将混合的拼音和文字进行分词并转换。

segmentPinyin(pinyin: string)

将连续的拼音字符串分解成带单引号分隔的拼音，便于阅读和理解。

split(text: string, options?: { useCorrector: boolean })

将拼音进行分词处理，返回分词结果和校正后的拼音数组。此函数是内部拼音分词算法的直接暴露。

特点

• 纯粹的拼音到中文转换功能
• 基于内置词库的离线转换
• 高效的DAWG结构支持
• 支持多种构建格式（ESM、UMD、CJS、IIFE）

注意事项

• 所有转换都在客户端完成，无需网络请求
• 适用于需要在应用程序中集成拼音转换功能的场景