如何解决TypeScript中ESLint的Promise处理相关代码检查错误？

问题背景 #

开发基于Node.js、TypeScript和Prisma的应用时，在实现数据库连接与服务器启动逻辑时，遇到了与Promise处理相关的ESLint代码检查错误，涉及@typescript-eslint/no-floating-promises和@typescript-eslint/no-misused-promises规则。

简化代码 #

import app from './app';
import config from './config/config';
import { PrismaClient } from '@prisma/client';

const client = new PrismaClient();

const startServer = async () => {
    try {
        await client.$connect();
        console.log('Connection to the database is established successfully.');

        app.listen(config.PORT, () => {
            console.log(`Server is listening on localhost:${config.PORT}`);
        });
    } catch (error) {
        console.error('Failed to start the server due to database connection issues:', error);
        process.exit(1);
    }
}

startServer();

process.on('uncaughtException', (err) => {
    console.error('Uncaught Exception:', err);
    process.exit(1);
});

// 问题所在
process.on('unhandledRejection', (err) => {
    console.error('Unhandled Rejection:', err);
    process.exit(1);
});

ESLint错误输出 #

C:\path\to\your\file.ts
  42:34  error  Promise returned in function argument where a void return was expected  @typescript-eslint/no-misused-promises

错误解决方法 #

1. 解决@typescript-eslint/no-floating-promises（针对startServer()调用） #

startServer()是异步函数，调用后返回的Promise未被处理，会触发该规则。可以通过以下方式修复：

• 添加.catch()处理启动过程中的未捕获错误：

  startServer().catch(err => {
    console.error('Failed to start server:', err);
    process.exit(1);
  });
  

• 或者用立即执行异步函数包裹：

  (async () => {
    await startServer();
  })().catch(err => {
    console.error('Failed to start server:', err);
    process.exit(1);
  });
  

2. 解决@typescript-eslint/no-misused-promises（针对unhandledRejection处理器） #

给处理器添加async会导致它返回Promise，但process.on的回调期望返回void，因此触发规则。正确做法：

• 保持处理器为非异步函数，直接处理错误：

  process.on('unhandledRejection', (err) => {
    console.error('Unhandled Rejection:', err);
    // 同步退出，避免异步操作导致进程挂起
    process.exit(1);
  });
  

• 如果必须在处理器中使用异步操作（比如记录错误到外部服务），可以在内部用立即执行异步函数包裹，确保回调本身不返回Promise：

  process.on('unhandledRejection', (err) => {
    (async () => {
      // 这里可以执行异步操作，比如记录到日志服务
      await logError(err);
      console.error('Unhandled Rejection:', err);
      process.exit(1);
    })().catch(() => process.exit(1)); // 确保异步操作的错误也被捕获
  });
  

Node.js处理未捕获Promise拒绝的最佳实践 #

• 将未捕获拒绝处理器作为最后防线：不要依赖它处理常规业务错误，应该在每个Promise调用处明确用.catch()或try/catch处理拒绝。
• 同步执行退出逻辑：在unhandledRejection和uncaughtException处理器中，尽量避免异步操作，因为Node.js在触发这些事件后可能会终止进程，异步操作可能无法完成。如果必须执行异步操作，要确保在操作完成后手动退出进程。
• 统一错误处理：在应用启动逻辑中，用async/await和try/catch集中处理初始化错误（比如数据库连接失败），避免错误扩散到全局处理器。
• 避免浮Promise：所有异步函数调用必须被明确处理，要么用await，要么用.catch()，防止触发no-floating-promises规则。
• Prisma连接最佳实践：在启动服务器前确保数据库连接成功，否则直接退出进程，避免服务器启动后无法处理请求。

内容的提问来源于stack exchange，提问作者Sami Ali