Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

pinyin-match

xmflswood10.6kMIT1.2.9TypeScript support: included

支持多音字, 繁体字,首字母缩写的拼音搜索引擎

拼音, chinese, pinyin, match

readme

如果有帮助,麻烦点个Star

具体实现文档

https://juejin.cn/post/6844904161461403661

pinyin-match

能够使用拼音快速检索目标。

  1. 简体版27KB (gzip ≈ 19KB),繁体版86KB (gzip ≈ 60KB)
  2. 支持多音字、繁体字、拼音首字母匹配,具备分词功能
  3. 返回位置信息,可用于高亮匹配字符
  4. 在长多音字串下依然有高性能

在线演示:https://xmflswood.github.io/pinyin-match/;

安装

npm install pinyin-match --save

支持<script>引入

简体:<script src="pinyin-match/dist/main.js"></script>

繁体:<script src="pinyin-match/dist/traditional.js"></script>

使用方式:
PinyinMatch.match('xxx', 'x')

API

.match(input, keyword)

查询匹配拼音的数据。

参数:

  1. input {string} 目标字符串
  2. keyword {string} 输入的拼音或其他关键词

返回:

{[Array]|{Boolean}}

使用范例

引入简体版:

import PinyinMatch from 'pinyin-match';  // es  

const PinyinMatch = require('pinyin-match'); // commonjs

引入繁体版(es):

import PinyinMatch from 'pinyin-match/es/traditional.js'; // es  

const PinyinMatch = require('pinyin-match/lib/traditional.js'); // commonjs

列表项为字符串:

let test = '123曾经沧海难为水除却巫山不是云'

PinyinMatch.match(test, '23曾'); // [1, 3]

PinyinMatch.match(test, 'cjc') // [3, 5]

PinyinMatch.match(test, 'cengjingcanghai') // [3, 6]

PinyinMatch.match(test, 'cengjingcangha') // [3, 6]

PinyinMatch.match(test, 'engjingcanghai') // false

PinyinMatch.match(test, 'zengjingcang') // [3, 5]

PinyinMatch.match(test, 'sdjkelwqf') // false

PinyinMatch.match(test, 'zengji ng cang') // [3, 5]

PinyinMatch.match(test, 'zengji ng cangsdjfkl') // false

PinyinMatch.match('   我 爱你 中   国   ', 'nzg') // [6, 12]

PinyinMatch.match('   我 爱你 中   国   ', '爱你中') // [5, 8]

PinyinMatch.match('發', 'fa') // [0, 0]

许可证

MIT

其他语言版本

欢迎其他语言开发者增加对应版本(标明来自本项目即可)

GO

https://github.com/limawanyan/go-pinyin-match

仓库

https://github.com/xmflswood/pinyin-match

changelog

更新日志

1.1.0

2020-03-30

BUG修复

  • 重写内部 getIndex 方法
    • 修复某些情况下,匹配字符没有按顺序的问题#7

1.1.4

2020-12-09

优化

  • 移除多音字 大(tai)的读音
  • 调整打包为rollup 支持es

1.2.0

2021-02-18

拓展

  • 新增繁体版本

1.2.3

2023-02-12

优化

  • 增加喆、钭
  • 移除多音字 体(ben)的读音

1.2.4

2023-02-25

优化

  • 优化拼音中 ü 的 u v打法,详见 issues/37

1.2.5

2023-11-25

优化

1.2.6

2024-08-29

优化

  • 简体字典增加 “啰”

1.2.7

2025-04-29

优化

1.2.8

2025-05-11

优化

1.2.9

2025-11-09

优化

  • 简体字典增加 “祎”