对于前端工程师来说，利用 async/await 和 promise 构建异步代码已经变得越来越流行。这一切都得益于 JavaScript 社区推出的 npm 包 promisify-core-api。在本文中，我们将深入了解 promisify-core-api 的方方面面以及如何使用它来提高我们的代码效率。
什么是 promisify-core-api?
promisify-core-api 是一个能够将 Node.js 核心 API 转换成 promise 形式的工具，使开发人员可以更加轻松地使用异步模式进行开发而无需再手动处理回调函数。它是由 Bluebird.js 的作者 Petka Antonov 开发的，不仅能够提供 Node.js 核心模块的 promisified 版本，还能够处理大量第三方库的回调函数。
如何安装 promisify-core-api?
promisify-core-api 可以通过 npm 进行安装。只需打开终端并在项目的根目录中运行以下命令即可：
npm install promisify-core-api
如何使用 promisify-core-api?
在使用 promisify-core-api 之前，我们需要在代码中引入它。以下是一个例子：
const pify = require('promisify-core-api');pify 方法接受一个对象（应该是一个 Node.js 核心 API 对象）以及一个可选的配置对象，如下所示：
pify(nodeApiObject, options);
其中，nodeApiObject 是 Node.js 核心模块中的一个对象，也就是需要 promisified 的对象。options 是一个用于定制返回 promise 的一些可选参数的对象。
下面是一个例子，演示了如何使用 promisify-core-api 将 fs.readdir 方法转化为 promise 形式：
-- -------------------- ---- -------
----- -- - --------------
----- ---- - ------------------------------
----- ------------ - -------- - -------- ---------- ----------------
----- -------- ------ -
--- -
----- ----- - ----- -------------------
-------------------
- ----- ------- -
-------------------
-
-
-------在这个示例代码中，我们使用了 promisify-core-api 将 fs 模块中的 readdir 方法转化为 readdirAsync 方法，它将返回一个 Promise，包含读取到的文件列表。
promisify-core-api 的 options 对象详解
promisify-core-api 的 options 对象支持以下属性：
| 属性 | 类型 | 描述 |
|---|---|---|
| suffix | String | 用于指定 promisified 方法的后缀。例如，如果 suffix 为 'Async'，则 promisified 方法的名称应该是原来方法名 + Async（例如 readdirAsync） |
| exclude | Array<string> | 指定不需要 promisified 的方法名清单。使用此选项可以排除某些方法不进行 promisified 转化，例如 exists 方法。 |
| multiArgs | Boolean | 如果设置为 true 则会在 Promise 的 resolve 阶段返回数组形式的多个参数，而不是一般的单个参数。如果需要多个参数，建议使用 callbackify。该选项默认为 false。 |
| errorMapper | Function | 用于在转换错误时重新映射错误消息的函数。默认情况下，它会保留原始错误消息，但可以使用该选项进行改变。例如，转换错误时需要做一些映射来更准确的指示错误。 |
promisified 获取多个参数的方法
当函数返回多个参数时，可以使用 multiArgs 选项来访问它们，如下所示：
-- -------------------- ---- -------
----- ---- - ------------------------------
-------- --------- -
--------------- - ----------- -- --------- -
-------------- - - -- - - ---
--
-
----- ------- - --- ----------
----- --------------- - ------------- - ---------- ---- -------------------
----- -------- ------ -
--- -
----- ----- -------- - ----- ------------------ ---
------------------- -----
----------------------- ---------
- ----- ------- -
-------------------
-
-
-------在这个例子中，我们定义了一个包含两个参数的方法，addNumbersAsync，在该方法中，我们使用了 multiArgs 选项，通过以数组形式将两个参数传递到 async 函数中。
合理使用 promisify-core-api
promisify-core-api 是现代前端开发的核心工具之一，它能够提高我们的代码效率。然而，我们应该注意，过度使用 Promisify 可能会导致无聊的 Promise 链，从而潜在地降低代码的可读性和可维护性。因此，我们应该始终保持谨慎并三思而后行。
在结束这篇技术文章之前，我们再一次强调：promisify-core-api 是一个强大的工具，可以提高代码效率，但要记住要使用它的变量名要更有意义，以便阅读代码时更容易理解。
总结
在本篇技术文章中，我们学习了 Node.js 核心 API 的 promisified 版本、学习了如何使用 promisify-core-api 将 Node.js 核心模块和第三方库的方法转化为 promise 形式，以及深入剖析了 promisify-core-api 的可选参数和其工作原理的方方面面。我们希望本文能够为开发者提供一个完整的 promisify-core-api 教程，帮助大家尽早地掌握 promisify-core-api，并在实际项目中灵活使用。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055c9c81e8991b448da010