Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

pinyin-pro

Package Overview
Dependencies
Maintainers
1
Versions
147
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

pinyin-pro

汉字转拼音库。获取汉字、词语、句子等内容的拼音、韵母、声母、声调等信息。

  • 3.0.6-beta.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
25K
decreased by-23.36%
Maintainers
1
Weekly downloads
 
Created
Source

pinyin-pro Logo

pinyin-pro —— 专业的汉字拼音转换工具

NPM version GITHUB star travis-build NPM Downloads Coverage Status MIT-license GITHUB-language

特色功能

  • 支持汉字、词语、句子等多种格式的拼音、声母、韵母、音调等多种转换形式
  • 支持多音字,词语句子智能获取读音
  • 支持繁体字和简体字
  • 支持字符串和数组两种输出格式
  • 通过高效的算法,有效加快查找速度
  • 对包体积进行了优化,保证识别准确的同时体积轻便

版本更新

当前版本: 3.0.4 -> 3.0.5

  • 优化 README.md 文档二维码大小

点击查看 版本更新文档

安装

npm 安装

npm install pinyin-pro

yarn 安装

yarn add pinyin-pro

引入

浏览器端:

import { pinyin } from 'pinyin-pro';

node 端:

const { pinyin } = require('pinyin-pro');

参数

pinyin(word, options) 接收两个参数

  • word:必填。String 类型,需要转化为拼音的中文
  • options:可选。Object 类型,用于配置各种输出形式,options 的键值配置如下:
参数说明类型可选值默认值
pattern输出的结果的信息(拼音 / 声母 / 韵母 / 音调)stringpinyin / initial / final / numpinyin
tone音调输出形式(拼音符号 / 数字 / 不加音调)stringsymbol / num / nonesymbol
type输出结果类型(字符串/数组)stringstring / arraystring
multiple输出多音字全部拼音(仅在 word 为长度为 1 的汉字字符串时生效)booleantrue / falsefalse

使用

基本用法

import { pinyin } from 'pinyin-pro'; // 若为node环境请用require形式引入

// 获取带音调拼音
pinyin('汉语拼音'); // 'hàn yǔ pīn yīn'
// 获取不带声调的拼音
pinyin('汉语拼音', { toneType: 'none' }); // 'han yu pin yin'
// 获取声调转换为数字后缀的拼音
pinyin('汉语拼音', { toneType: 'num' }); // 'han4 yu3 pin1 yin1'
// 获取声母
pinyin('汉语拼音', { pattern: 'initial' }); // 'h y p y'
// 获取带音调韵母
pinyin('汉语拼音', { pattern: 'final' }); // 'àn ǔ īn īn'
// 获取不带音调韵母
pinyin('汉语拼音', { pattern: 'final', toneType: 'none' }); // 'an u in in'
// 获取音调为数字的韵母
pinyin('汉语拼音', { pattern: 'final', toneType: 'num' }); // 'an4 u3 in1 in1'
// 获取音调
pinyin('汉语拼音', { pattern: 'num' }); // '4 3 1 1'

结果输出为数组格式

通过在 options 参数中加入type: 'array',可以以数组形式输出基本用法中的示例:

// 获取带音调拼音
pinyin('汉语拼音', { type: 'array' }); // ["hàn", "yǔ", "pīn", "yīn"]
// 获取不带声调的拼音
pinyin('汉语拼音', { toneType: 'none', type: 'array' }); // ["han", "yu", "pin", "yin"]
// 获取声调转换为数字后缀的拼音
pinyin('汉语拼音', { toneType: 'num', type: 'array' }); // ["han4", "yu3", "pin1", "yin1"]
// 获取声母
pinyin('汉语拼音', { pattern: 'initial', type: 'array' }); // ["h", "y", "p", "y"]
// 获取带音调韵母
pinyin('汉语拼音', { pattern: 'final', type: 'array' }); // ["àn", "ǔ", "īn", "īn"]
// 获取不带音调韵母
pinyin('汉语拼音', { pattern: 'final', toneType: 'none', type: 'array' }); // ["an", "u", "in", "in"]
// 获取音调
pinyin('汉语拼音', { pattern: 'num', type: 'array' }); // ["4", "3", "1", "1"]

获取单个字的多音

只有单字可以获取到多音模式, 词语、句子无效。同样可以通过配置 options 选项获取数组形式、韵母等格式

pinyin('好', { multiple: true }); // 'hǎo hào'
pinyin('好', { multiple: true, type: 'array' }); // ["hǎo", "hào"]

贡献与反馈

使用遇到问题或者需要功能支持欢迎提 issue。

交流及参与贡献欢迎加微信:

Keywords

FAQs

Package last updated on 24 Mar 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc