# pinyin2group

**Repository Path**: york17/pinyin2group

## Basic Information

- **Project Name**: pinyin2group
- **Description**: 基于pinyin4js的通讯录分组排序工具
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://github.com/York0519/pinyin2group
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 1
- **Created**: 2019-04-01
- **Last Updated**: 2024-04-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## pinyin2group 
[![Downloads](https://img.shields.io/npm/dy/pinyin2group.svg)](https://www.npmjs.com/package/pinyin2group)
[![Version](https://img.shields.io/npm/v/pinyin2group.svg)](https://www.npmjs.com/package/pinyin2group)
[![License](https://img.shields.io/npm/l/pinyin2group.svg)](https://www.npmjs.com/package/pinyin2group)
> 基于[pinyin4js](https://github.com/superbiger/pinyin4js)的通讯录分组排序工具   
> 注：暂仅支持Node  

## 特点
* **通讯录分组排序工具**   

* **方便通讯录调用**   
以首字母分组、可选补全26个字母、排序时同一字母自动比较下一个  

* **准确、完善的字库**  
Unicode编码从4E00-9FA5范围及3007（〇）的20903个汉字中，pinyin4js能转换除46个异体字（异体字不存在标准拼音）之外的所有汉字  

* **拼音转换速度快**  
经测试，从4E00-9FA5范围的20902个汉字，pinyin4js耗时约110毫秒  

* **多拼音格式输出支持**  
支持多种拼音输出格式：带音标、不带音标、数字表示音标以及拼音首字母输出格式  

* **常见多音字识别**  
支持常见多音字的识别，其中包括词组、成语、地名等  

* **简繁体中文转换**  

## 怎么用

* **INSTALL**  
```
    npm install pinyin2group
```

* **USE**  

#### Node

```javascript
    //pinyin2group@1.1.0 or latest
    import { Pinyin2Group } from './Pinyin2Group';

    // more detail methods in test

    // output: [ { letter: 'A', wordsList: [] },
    // { letter: 'B', wordsList: [] },
    // { letter: 'C', wordsList: [] },
    // ...
    // { letter: 'W', wordsList: [] },
    // { wordsList: [ [Object] ], letter: 'X' },
    // { letter: 'Y', wordsList: [] },
    // { letter: 'Z', wordsList: [] } ]
    console.log(new Pinyin2Group().groupByFirstLetter([{ word: '厦门你好大厦厦门' }]));

    // output: [ { wordsList: [ [Object] ], letter: 'X' } ]
    console.log(new Pinyin2Group().groupByFirstLetter([{ word: '厦门你好大厦厦门' }], { hasFullLetter: false }));

    // output: xiamennihaodashaxiamen
    console.log(new Pinyin2Group().getPinyinWithoutTone('厦门你好大厦厦门'));

    // output: XIAMENNIHAODASHAXIAMEN
    console.log(new Pinyin2Group().getPinyinWithoutTone('厦门你好大厦厦门', { isUppercase: true }));

    // output: xia men ni hao da sha xia men
    console.log(new Pinyin2Group().getPinyinWithoutTone('厦门你好大厦厦门'), { separator: ' ' });

```