如何使用@types/express-session？

Question

当我写这个时：

import { Request } from 'express-serve-static-core';

router.post((req: Request, res, next) => {
  req.session.user = user;
}

tsc 给我一个错误：

'对象可能是'未定义'。

我知道原来的Request 类型没有session 字段。

我检查@types/express-sessionindex.d.ts文件，发现这个：

declare global {
  namespace Express {
    interface Request {
      session?: Session;
      sessionID?: string;
    }
  //....
}

所以我想在req 中添加额外的字段session 和sessionID。

我该如何使用？像这样：req: Request & ExpressSessionRequest.

所以req 将具有原始Request 类型和@types/express-session 添加的额外字段类型。

Answer 1

问题不在于Request 没有session 或sessionID 属性——express-session 的类型已经通过declaration merging 将属性添加到Request 接口。

错误来自打开strictNullChecks 编译器选项。由于属性session 在类型定义中被声明为可为空，因此编译器会准确地警告您。如果您确定req.session 不是未定义的空值，您可以使用not-null assertion operator (!) 来抑制错误：

router.post((req: Request, res, next) => {
    req!.session!.user = user;
})

或者明确检查 null|undefined：

router.post((req: Request, res, next) => {
    if (req.session) {
        req.session.user = user;
    }
})

---

如果您想让session 和sessionID 属性不可为空，那么您可以编写自己的自定义类型：

type YourSessionRequest = Request & {
    session: Express.Session;
    sessionID: string;
}
router.post((req: YourSessionRequest, res, next) => {
    req.session.user = user;
})