pyfl

把中文转换成拼音首字母

在 npm 查看 · 反馈问题

pyfl 是一个面向浏览器的拼音首字母转换库。传入一段文本，它会逐字转换其中的常用汉字，并原样保留英文、数字、空格和符号。

适合用来生成搜索索引、通讯录首字母和中文标题缩写。它不做分词、多音字推断或完整拼音转换，只专注于快速得到首字母。

安装

yarn add pyfl

也可以使用 npm：

npm install pyfl

使用

import pyfl from "pyfl";

pyfl("喵");                    // "M"
pyfl("你好，世界");             // "NH，SJ"
pyfl("Made by ❤");            // "Made by ❤"
pyfl("好笑吗跟傻子一样整天就知道哈哈哈哈哈哈哈");
// "HXMGSZYYZTJZDHHHHHHH"

CommonJS 项目需要读取默认导出：

const pyfl = require("pyfl").default;

转换规则

• 常用汉字转换为大写拼音首字母
• 英文、数字、空格和符号保持不变
• 空字符串或只包含半角空格的字符串返回空字符串
• 非字符串输入会先通过模板字符串转换为文本

pyfl(123456);    // "123456"
pyfl(undefined); // "undefined"
pyfl(null);      // "null"

从源码构建

git clone https://github.com/yuxino/pyfl.git
cd pyfl
yarn
yarn test
yarn build

pyfl 最初为 WeChat 项目而写，字典实现改编自 pinyinjs。

说明

• 转换基于内置字典，不会发起网络请求
• 多音字按字典中的固定读音处理，不结合上下文推断
• 当前字典覆盖 Unicode U+4E00 至 U+9FA5 范围内的汉字；范围外字符保持原样
• 欢迎通过 Issue 补充缺字或报告错误读音

MIT © yuxino