# @braintree/wrap-promise 中文文档

规范地址：https://npmcn.com/package/%40braintree/wrap-promise/

版本：3\.0\.4
npm 元数据更新时间：2026-01-29T18:34:45.168Z
中文译文更新时间：2026-11-08T13:44:51.585Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：8.6 kB，11 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2017-06-01T19:07:02.374Z
- 最新版本发布：2026-01-29T18:34:45.052Z
- 近 30 天下载量：4153761（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 1 个）

## 中文简介

一个小的回扣或回扣

## 安装

```sh
npm install @braintree/wrap-promise
```

也可以使用：`pnpm add @braintree/wrap-promise`、`yarn add @braintree/wrap-promise`、`bun add @braintree/wrap-promise`

## README

# 结束承诺

帮助支持返回承诺或使用回调的API的小型模块.

### 示例

```js
// my-method.js
var wrapPromise = require("wrap-promise");

function myMethod(arg) {
  return new Promise(function (resolve, reject) {
    doSomethingAsync(arg, function (err, response) {
      if (err) {
        reject(err);
        return;
      }

      resolve(response);
    });
  });
}

module.exports = wrapPromise(myMethod);

// my-app.js
var myMethod = require("./my-method");

myMethod("foo")
  .then(function (response) {
    // do something with response
  })
  .catch(function (err) {
    // handle error
  });

myMethod("foo", function (err, response) {
  if (err) {
    // handle error
    return;
  }

  // do something with response
});
```

### 在原型上环绕所有方法

```js
function MyObject() {}

MyObject.prototype.myAsyncMethod = function () {
  return new Promise(function (resolve, reject) {
    //
  });
};

MyObject.prototype.myOtherAsyncMethod = function () {
  return new Promise(function (resolve, reject) {
    //
  });
};

module.exports = wrapPromise.wrapPrototype(MyObject);
```

静态方法,原型上的同步方法(虽然您通过一个函数作为您同步方法的最后一个参数,您会得到一个错误),原型上的非函数属性被忽略.

如果你想忽略某些方法,你可以通过一个 `ignoreMethods` 阵列.

```js
module.exports = wrapPromise.wrapPrototype(MyObject, {
  ignoreMethods: ["myMethodOnThePrototypeIDoNotWantTransformed"],
});
```

默认, `wrapPrototype` 忽略以下划线开头的方法。 您可以通过 : `transformPrivateMethods: true`

```js
module.exports = wrapPromise.wrapPrototype(MyObject, {
  transformPrivateMethods: true,
});
```

## 常见问题

### @braintree/wrap-promise 是什么？

一个小的回扣或回扣

### 如何安装 @braintree/wrap-promise？

在项目目录运行 npm install @braintree/wrap-promise，或使用 pnpm add / yarn add / bun add。

### @braintree/wrap-promise 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @braintree/wrap-promise 支持 ESM 还是 CommonJS？

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

### @braintree/wrap-promise 可以商用吗？

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

### @braintree/wrap-promise 的下载量有多少？

根据 npm 官方下载统计，@braintree/wrap-promise 在 2026/10/09 – 2026/11/07 这 30 天内被下载 4,153,761 次，日均约 138,459 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @braintree/wrap-promise 还在维护吗？

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