TypeScript/Eslint 在 Express Router 异步路由上抛出“Promise returned”错误

Question

我有以下端点设置来在测试运行后重置数据库：

import { getConnection } from 'typeorm';
import express from 'express';
const router = express.Router();

const resetDatabase = async (): Promise<void> => {
  const connection = getConnection();
  await connection.dropDatabase();
  await connection.synchronize();
};

// typescript-eslint throws an error in the following route:
router.post('/reset', async (_request, response) => {
  await resetTestDatabase();
  response.status(204).end();
});

export default router;

自 async 以来的整个路线都带有 typescript-eslint 错误 Promise returned in function argument where a void return was expected. 下划线

该应用程序运行良好，但我不确定是否应该进行更安全的实施，或者只是忽略/禁用 Eslint。知道该代码有什么问题吗？

Answer 1

您似乎正在使用no-misused-promises 规则，该规则规定您不能在需要void 的地方返回Promise<void>。

这意味着您不能从您的 Express 处理程序返回 Promise<void>，因为库中 RequestHandler 的返回类型指定返回类型应为 void。我建议您通过添加一个简单的return 关键字将其更改为返回Promise<Response>：

import { getConnection } from 'typeorm';
import express from 'express';
const router = express.Router();

const resetDatabase = async (): Promise<void> => {
  const connection = getConnection();
  await connection.dropDatabase();
  await connection.synchronize();
};

// typescript-eslint throws an error in the following route:
router.post('/reset', async (_request, response) => {
  await resetTestDatabase();
  return response.status(204).send();  // <----- return added here
});

export default router;

另一种选择是避免使用async/await：

router.post('/reset', (_request, response) => {
  resetDatabase().then(() => response.status(204).send());
});

Answer 2

我找到了一个不涉及使用 then() 的解决方案，让您可以使用异步的抽象而不会被 eslint 诅咒，有两种解决方案 （但我更推荐第二种）

第一个解决方案：使用“内部异步”

这是在 void 中使用异步的基本方法，如下所示：

router.post('/reset', (_request, response) => {
    (async () => {
        await resetTestDatabase();
        response.status(204).end();
    })()
});

第二种解决方案（推荐）：“类型重叠”

第二个选项是你将它用作异步，一如既往，但是用“as”关键字说“嘿 TypeScript，这里没什么问题，呵呵”

import { RequestHandler } from 'express'

router.post('/reset', (async (_request, response) => {
    await resetTestDatabase();
    response.status(204).end();
}) as RequestHandler);