TypeScript：扩展Express。具有自己类的会话接口

Question

我正在处理一个带有npm包的Types cript项目。我想向Express添加一个属性。会话接口。

示例类：

class User {
    name: string;
    email: string;
    password: string;
}

export = User;

接口定义的新d.ts文件（不想编辑express-session.d.ts）：

declare namespace Express {
    interface Session {
        user: User
    }
}

app.ts

import User = require('./User');

function (req: express.Request, res: express.Response) {
    req.session.user //I want to use it like this.
}

问题是，用户在de d.ts文件中未知。但既不需要也不导入用户文件来修复这一问题。

如何将自己的类添加到会话界面？

Answer 1

对于我来说，类型。快速会话。d、 ts：

declare namespace Express {
    interface CustomSessionFields {
        myCustomField: string
    }

    export interface Request {
        session: Session & Partial<SessionData> & CustomSessionFields
    }
}

这个答案与这个帖子有关

Answer 2

虽然有点晚了，但应该可以将您的接口导入到定义文件中

import { User } from '../models/user';

declare global {
  namespace Express {
    interface Session {
      _user?: User
    }
  }
}

Answer 3

可能是由于软件包版本的原因，Vitalii Zurian提供的答案不适用于我。如果您想在req上扩展会话数据。并通过TSC类型检查，您应该扩展SessionData接口。

例如。

<代码>用户。ts：

class User {
  name: string = '';
  email: string = '';
  password: string = '';
}

export = User;

app.ts：

import express from 'express';
import User from './User';

declare module 'express-session' {
  interface SessionData {
    user: User;
  }
}

function controller(req: express.Request, res: express.Response) {
  req.session.user;
}

软件包版本：

json prettyprint-override">"express": "^4.17.1",
"express-session": "^1.17.1",
"@types/express-session": "^1.17.3",
"@types/express": "^4.17.11",
"typescript": "^3.9.7"

结果：