# @ggascoigne/namor 中文文档

规范地址：https://npmcn.com/package/%40ggascoigne/namor/

版本：2\.0\.4
npm 元数据更新时间：2022-04-05T14:09:01.501Z
中文译文更新时间：2026-11-16T07:23:42.796Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40ggascoigne/namor
原文对照：https://npmcn.com/package/%40ggascoigne/namor/?lang=original
项目主页：https://github.com/jsonmaur/namor#readme
源码仓库：https://github.com/jsonmaur/namor

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：77.1 kB，17 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=6
- 运行依赖：0 个
- 首次发布：2020-06-10T02:29:53.087Z
- 最新版本发布：2022-02-27T00:24:38.589Z
- 近 30 天下载量：7226（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

一个域名生成器

## 安装

```sh
npm install @ggascoigne/namor
```

也可以使用：`pnpm add @ggascoigne/namor`、`yarn add @ggascoigne/namor`、`bun add @ggascoigne/namor`

## README

  
![](https://raw.githubusercontent.com/jsonmaur/namor/master/assets/logo.png)  
  
  
[![Build Status](https://travis-ci.org/jsonmaur/namor.svg?branch=master)](https://travis-ci.org/jsonmaur/namor) [![Coverage Status](https://coveralls.io/repos/github/jsonmaur/namor/badge.svg?branch=master)](https://coveralls.io/github/jsonmaur/namor?branch=master)  
  
  

一个生成随机, URL 友好名称的节点名称生成器 。 如果您需要生成独有的子域( 如 Heroku 所做的) , 或为其它任何事物指定独有的名称, 则此语有帮助 。 它可以对照一个保留的单词列表来检查以防止恶意子域,并生成一个崎岖性质的名字.

> _请注意:出品人名并非总能保证其独特. 为了减少相撞的可能性,可以增加后继数字的长度([此处参见相撞数据](https://npmcn.com/package/%40ggascoigne/namor/#readme-collision)) (中文(简体) ). 在假设生成的值是独一无二之前, 总是要检查您的数据库 ._

## 开始

```bash
$ npm install namor --save
```

```javascript
const namor = require("namor")

/* defaults to two words and 5 random characters */
const name = namor.generate()

/* generate 3 words and no random characters */
const name = namor.generate({ words: 3, saltLength: 0 })

/* enable manly mode */
const name = namor.generate({ subset: "manly" })
```

[看这里的动作](https://namor-example.herokuapp.com/) 或者说 [体验男性模式](https://namor-example.herokuapp.com/?subset=manly&saltLength=0)。 。 。 .

## 碰撞状态

以下数据给出了基于单词计数(没有盐分)的通量总数,并可以帮助您决定盐分的长短. 此数据基于目前我们拥有的单词数量 [词典文件](https://npmcn.com/package/%40ggascoigne/namor/data)。 。 。 .

-   1个字组合:1 319个
-   2个字组合:3 016 553个
-   3个字组合:1 720 200 230
-   4个字组合:2 268 944 103 370

##### 子集: 曼丽

-   1个字组合: 282
-   2个字组合:110 826
-   3个字组合:9 487 044个
-   4个字组合:2 675 346 408个

## API 密码

### 遗传( 选项: 对象)

出出一新名,以所出之荣.

-   **选项**
    
    -   **单词** `default: 2` 生成名称中要包含的字数 。 必须是不超过4或0的正整数才能产生出一分盐.
        
    -   **分隔符** `default: "-"` 生成名称时用于单词之间的字符 .
        
    -   **盐质** `default: 5` 后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后出后 必须是正整数或 `0` 以排除后继数字.
        
    -   **盐类** `default: "mixed"` 后缀盐要使用的字符类型. 可能会 `number`, (中文(简体) ), `string`,或 `mixed`。 。 。 .
        
    -   **子集** 是否使用子集词典而不是默认值 。 要注意这限制了字典字数,创造了较高的相撞机会. 目前唯一有效的值是 `"manly"`。 。 。 .
        

### .validate(名称:String, 选项: Object)

检查字符串作为子域是否有效,包括长度(最大63个字符)和对照列表检查 [保留子域](https://npmcn.com/package/%40ggascoigne/namor/data/default/reserved.txt) 为了防止出事.

-   **名称** -要检查的名字.
    
-   **选项**
    
    -   **保留** `default: false` 是否对照 [保留单词列表](https://npmcn.com/package/%40ggascoigne/namor/data/default/reserved.txt),这是一组预设的子域,应当保持私有状态.

### 粗略数据

允许访问原始词典数据。 你可能不会用这个 但如果你需要它 它就在那里.

## 许可证

[麻省理工学院](https://npmcn.com/package/%40ggascoigne/namor/license) © [贾森·莫雷尔](https://maur.co/)

## 常见问题

### @ggascoigne/namor 是什么？

一个域名生成器

### 如何安装 @ggascoigne/namor？

在项目目录运行 npm install @ggascoigne/namor，或使用 pnpm add / yarn add / bun add。

### @ggascoigne/namor 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/ggascoigne\_\_namor 是否存在。

### @ggascoigne/namor 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @ggascoigne/namor 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=6。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @ggascoigne/namor 可以商用吗？

@ggascoigne/namor 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @ggascoigne/namor 的下载量有多少？

根据 npm 官方下载统计，@ggascoigne/namor 在 2026/10/17 – 2026/11/15 这 30 天内被下载 7,226 次，日均约 241 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @ggascoigne/namor 还在维护吗？

最新版本 2\.0\.4 发布于 2022/02/27（4 年前）；至今共发布 3 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/06/10。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

