# once 中文文档

规范地址：https://npmcn.com/package/once/

版本：1\.4\.0
npm 元数据更新时间：2026-03-01T13:17:51.972Z
中文译文更新时间：2026-11-04T19:17:47.163Z
软件包许可：ISC

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

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

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

- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2012-08-14T07:25:56.929Z
- 最新版本发布：2016-09-06T21:11:09.367Z
- 近 30 天下载量：682857767（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 0 个）

## 中文简介

只运行一个函数一次

## 安装

```sh
npm install once
```

也可以使用：`pnpm add once`、`yarn add once`、`bun add once`

## README

# 一次

只调用一个函数一次。

## 用法

```javascript
var once = require('once')

function load (file, cb) {
  cb = once(cb)
  loader.load('file')
  loader.once('load', cb)
  loader.once('error', cb)
}
```

或者添加到函数中。以负责任的方式制作原型：

```javascript
// only has to be done once
require('once').proto()

function load (file, cb) {
  cb = cb.once()
  loader.load('file')
  loader.once('load', cb)
  loader.once('error', cb)
}
```

具有讽刺意味的是，原型特性使这个模块成为 尽可能复杂。

要检查函数是否已被调用，请使用 `fn.called`． 一旦 函数第一次调用时返回原函数的返回值 函数保存在 `fn.value` 随后的电话将继续 返回此值。

```javascript
var once = require('once')

function load (cb) {
  cb = once(cb)
  var stream = createStream()
  stream.once('data', cb)
  stream.once('end', function () {
    if (!cb.called) cb(new Error('not found'))
  })
}
```

## `once.strict(func)`

如果函数被调用两次，则抛出错误。

有些函数只被调用一次。使用 `once` 因为他们会 潜在地隐藏逻辑错误。

在下面的示例中， `greet` 函数只能调用回调一次：

```javascript
function greet (name, cb) {
  // return is missing from the if statement
  // when no name is passed, the callback is called twice
  if (!name) cb('Hello anonymous')
  cb('Hello ' + name)
}

function log (msg) {
  console.log(msg)
}

// this will print 'Hello anonymous' but the logical error will be missed
greet(null, once(msg))

// once.strict will print 'Hello anonymous' and throw an error when the callback will be called the second time
greet(null, once.strict(msg))
```

## 常见问题

### once 是什么？

只运行一个函数一次

### 如何安装 once？

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

### once 支持 TypeScript 吗？

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

### once 支持 ESM 还是 CommonJS？

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

### once 可以商用吗？

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

### once 的下载量有多少？

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

### once 还在维护吗？

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