开源项目 `util.promisify` 使用教程

开源项目 util.promisify 使用教程

util.promisifyPolyfill/shim for util.promisify in node versions < v8项目地址:https://gitcode.com/gh_mirrors/ut/util.promisify

项目介绍

util.promisify 是一个用于将基于回调的函数转换为返回 Promise 的函数的工具库。它是 Node.js 内置 util 模块中 promisify 方法的一个独立实现，可以在不支持该方法的旧版本 Node.js 环境中使用。

项目快速启动

安装

首先，你需要通过 npm 安装 util.promisify：

npm install util.promisify

基本使用

以下是一个简单的示例，展示如何使用 util.promisify 将基于回调的函数转换为 Promise：

const { promisify } = require('util.promisify');
const fs = require('fs');

// 将 fs.readFile 转换为返回 Promise 的函数
const readFileAsync = promisify(fs.readFile);

// 使用 async/await 读取文件
(async () => {
  try {
    const data = await readFileAsync('example.txt', 'utf8');
    console.log(data);
  } catch (err) {
    console.error(err);
  }
})();

应用案例和最佳实践

应用案例

假设你有一个基于回调的函数 getUserData，你可以使用 util.promisify 将其转换为 Promise：

const { promisify } = require('util.promisify');

function getUserData(userId, callback) {
  // 模拟异步操作
  setTimeout(() => {
    if (userId === 1) {
      callback(null, { id: 1, name: 'Alice' });
    } else {
      callback(new Error('User not found'));
    }
  }, 1000);
}

const getUserDataAsync = promisify(getUserData);

(async () => {
  try {
    const user = await getUserDataAsync(1);
    console.log(user);
  } catch (err) {
    console.error(err);
  }
})();

最佳实践

1. 避免丢失上下文：在使用 util.promisify 转换类方法时，确保不丢失 this 上下文。可以使用 bind 方法：

   const { promisify } = require('util.promisify');
   
   class MyClass {
     constructor() {
       this.value = 42;
     }
   
     myMethod(callback) {
       callback(null, this.value);
     }
   }
   
   const obj = new MyClass();
   const myMethodAsync = promisify(obj.myMethod).bind(obj);
   
   (async () => {
     try {
       const result = await myMethodAsync();
       console.log(result);
     } catch (err) {
       console.error(err);
     }
   })();
   

2. 处理多个回调参数：util.promisify 默认只处理单个结果值。如果回调函数返回多个参数，可以使用自定义的 promisify.custom 属性：

   const { promisify } = require('util.promisify');
   
   function myFunction(callback) {
     callback(null, 'result1', 'result2');
   }
   
   myFunction[promisify.custom] = (...args) => {
     return new Promise((resolve, reject) => {
       myFunction((err, ...results) => {
         if (err) return reject(err);
         resolve(results);
       });
     });
   };
   
   const myFunctionAsync = promisify(myFunction);
   
   (async () => {
     try {
       const [result1, result2] = await myFunctionAsync();
       console.log(result1, result2);
     } catch (err) {
       console.error(err);
     }
   })();
   

典型生态项目

util.promisify 可以与许多 Node.js 生态系统中的项目结合使用，例如：

1. fs-extra：一个增强版的文件系统模块，提供了更多的文件操作方法。

util.promisifyPolyfill/shim for util.promisify in node versions < v8项目地址:https://gitcode.com/gh_mirrors/ut/util.promisify