cnname
TypeScript icon, indicating that this package has built-in type declarations

2.2.0 • Public • Published

简体中文 | English

cnname

👦 随机生成中文名 👧

Version download Coverage Status Test in Vitest PRs Welcome GitHub license

⚡️ 在线体验

在 StackBlitz 中打开

✨ 特性

  • 🎲 轻松简单的生成各种随机中文姓名。
  • 🎭 支持丰富的姓氏类型和名字特性。
  • ⚡ 轻量级库,快速生成,无额外依赖。
  • 🛠 提供多种 API,可自定义生成规则。
  • 📚 适用于测试数据、小说创作、游戏角色等场景。

📦 安装

npm install cnname
yarn add cnname
pnpm install cnname

🚀 使用示例

import { getName } from 'cnname';

getName();
// -> 李炜
getName('高');
// -> 高佳倩
getName(5);
// -> ["余嘉扬", "郭东仪", "谢鸿宾", "彭天奇", "关智华"]
getName('张', 5);
// -> ["张腾", "张怡莉", "张瑞宇", "张萍", "张韵思"]
getName({ count: 5, gender: 'female' });
// -> ["庞妙", "黄如嫣", "姜莹", "莫惠安", "周敏"]

📖 API

getName(): string

获取一个随机姓名。

getName(surname: string): string

获取指定姓氏的随机姓名。

getName(num: number): string[]

获取指定数量的随机姓名。

getName(surname: string, num: number): string[]

获取指定姓氏和数量的随机姓名。

getName(options: Options): string[]

通过高级选项获取姓名。支持性别、五行、叠字名、复姓等丰富功能。👉 查看文档

🛠️ 工具方法

📚 资源

以下为资源库,如果缺少了你想要的姓氏或名字,欢迎补充

✍️ 示例

import { getName } from 'cnname';

const 主角 = getName();
const 反派 = getName('张');

const novel = `
# 第 1 章 千人围攻

"${主角},你已经被我们围攻了!!!"

${反派}的厉啸从身后传来,随着尖锐的破空声,一声利箭没入${主角}身旁的黄土墙。

${主角}心头微凉,定睛一看。

只见阴暗的密林四处,已经隐隐约约钻出千道黑色人影。

他们分别是:

${getName(1000).join(',')}
`;

👉 输出结果

🔑 许可证

MIT

Package Sidebar

Install

npm i cnname

Weekly Downloads

362

Version

2.2.0

License

MIT

Unpacked Size

58.2 kB

Total Files

8

Last publish

Collaborators

  • yaoyuanzhang