Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xmflswood/pinyin-match
拼音匹配，具备分词、缩写、多音字匹配能力，支持繁体版
https://github.com/xmflswood/pinyin-match
Last synced: 30 days ago
JSON representation
拼音匹配，具备分词、缩写、多音字匹配能力，支持繁体版
- Host: GitHub
- URL: https://github.com/xmflswood/pinyin-match
- Owner: xmflswood
- License: other
- Created: 2018-07-04T12:36:13.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-29T15:09:05.000Z (3 months ago)
- Last Synced: 2024-10-29T15:29:36.980Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 420 KB
- Stars: 847
- Watchers: 16
- Forks: 118
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-star-libs - xmflswood / pinyin-match
README
# 如果有帮助，麻烦点个Star
# 具体实现文档
https://juejin.cn/post/6844904161461403661
# pinyin-match
能够使用拼音快速检索目标。
1. 简体版27KB (gzip ≈ 19KB)，繁体版86KB (gzip ≈ 60KB)
2. 支持多音字、繁体字、拼音首字母匹配,具备分词功能
3. 返回位置信息，可用于高亮匹配字符
4. 在长多音字串下依然有高性能
在线演示：;
## 安装
```shell
npm install pinyin-match --save
```
支持``引入
简体：`<script src="pinyin-match/dist/main.js">`
繁体：``
使用方式：
`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
```
列表项为字符串：
```js
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]
```
## 许可证
pinyin-match is under The Star And Thank Author License (SATA)
本项目基于MIT协议发布，并增加了SATA协议
## 其他语言版本
欢迎其他语言开发者增加对应版本（标明来自本项目即可）
### GO
https://github.com/limawanyan/go-pinyin-match
## 仓库
https://github.com/xmflswood/pinyin-match