npm 包 e2k 使用教程-JavaScript中文网-JavaScript教程资源分享门户

前言

e2k 是一个 npm 包，用于将英文字符串转换为卡拉OK风格的假名。在前端开发中，经常需要将英文字符串转换为假名形式，此时就可以使用 e2k 包来方便地实现。

安装

使用 npm 命令进行安装：

npm install e2k --save

使用

使用 e2k 的核心是 convert 方法。以下是一个简单的使用示例：

const e2k = require('e2k');

const input = 'Hello, world!';
const output = e2k.convert(input);
console.log(output); // 输出：ヘッローワールド！

参数

convert 方法接受两个参数：输入字符串和配置选项。配置选项是可选的，默认情况下，e2k 会使用预设的配置。

e2k.convert(input, options);

预设配置

e2k 内置了两个预设配置：default 和 karaoke。

default 预设是 e2k 内置的默认配置，主要区别是在转换自拍音节时，使用长音符「ー」代替短音符「ゥ」。使用默认配置时，可以省略配置选项：

const e2k = require('e2k');

const input = 'Hello, world!';
const output = e2k.convert(input);
console.log(output); // 输出：ヘッローワールド！

karaoke 预设是针对卡拉OK歌曲制作的，所以在转换自拍音节时，使用短音符「ゥ」代替长音符「ー」。如果需要使用 karaoke 预设，可以这样设置：

const e2k = require('e2k');

const input = 'Hello, world!';
const output = e2k.convert(input, { preset: 'karaoke' });
console.log(output); // 输出：ヘッロゥワールド！

自定义配置

e2k 的配置选项支持更多的自定义。以下是配置选项的完整列表：

属性	类型	默认值	描述
`convertLongVowel`	`boolean`	`true`	是否将「おう」转换为「オー」。
`convertSmallLetter`	`boolean`	`false`	是否将小写字母转换为假名形式。
`extendSmallLetter`	`boolean`	`false`	是否将小写字母转换为长音符假名。
`convertCapitalLetter`	`boolean`	`false`	是否将大写字母转换为假名形式。
`extendCapitalLetter`	`boolean`	`false`	是否将大写字母转换为长音符假名。
`convertCrab`	`boolean`	`false`	是否将「かに」转换为「カニ」。
`convertLongDash`	`boolean`	`false`	是否将长破折号「―」转换为长音符「ー」。
`convertHalfDash`	`boolean`	`false`	是否将半角破折号「-」转换为「ー」。
`convertFullStop`	`boolean`	`false`	是否将全角句号「。」转换为半角句号「.」。
`convertQuestionMark`	`boolean`	`false`	是否将全角问号「？」转换为半角问号「?」。
`convertExclamationMark`	`boolean`	`false`	是否将全角感叹号「！」转换为半角感叹号「!」。
`convertComma`	`boolean`	`false`	是否将全角逗号「、」转换为半角逗号「,」。
`convertColon`	`boolean`	`false`	是否将全角冒号「：」转换为半角冒号「:」。
`convertSemicolon`	`boolean`	`false`	是否将全角分号「；」转换为半角分号「;」。
`convertSpace`	`boolean`	`false`	是否将全角空格「　」转换为半角空格「」。
`convertFullWidthLetter`	`boolean`	`false`	是否将全角字符转换为假名形式。
`convertFullWidthPunctuation`	`boolean`	`false`	是否将全角标点符号转换为半角标点符号。
`convertFullWidthDigit`	`boolean`	`false`	是否将全角数字转换为半角数字。
`convertFullWidthSymbol`	`boolean`	`false`	是否将全角符号转换为半角符号。
`convertFullWidthMathematicalSymbol`	`boolean`	`false`	是否将全角数学符号转换为半角数学符号。
`convertFullWidthGreekLetter`	`boolean`	`false`	是否将全角希腊字母转换为半角希腊字母。
`convertFullWidthRomanNumeral`	`boolean`	`false`	是否将全角罗马数字转换为半角罗马数字。

以下是一个自定义配置的使用示例：

const e2k = require('e2k');

const input = 'Hello, world!';
const output = e2k.convert(input, { convertSmallLetter: true });
console.log(output); // 输出：ヘッloー,　world！

结语

以上是 npm 包 e2k 的使用教程。如果你需要将英文字符串转换为假名形式，e2k 是一个非常方便和高效的工具。在使用过程中，还可以根据需要自定义配置，实现更精细和专业的转换效果。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/600671d730d0927023822e1f