how to declare typescript interface extension to node request session object?

Question

In the following, returnTo is added to the session object by my passport methods. How do I declare its interface in typescript?

import express = require('express');
import expressSession = require('express-session');

// how to declare presence of returnTo, which is not in underlying type?

export function createSession(req: express.Request, res: express.Response, next: Function) {

  passport.authenticate('local', (err: any, user: UserInstance, info: any) => {
    //. . .
    req.logIn(user, (err) => {
      //. . .
      res.redirect(req.session.returnTo || '/');
    });
  })(req, res, next);
};

Daniel Earwicker · Accepted Answer · 2015-07-09 07:04:21Z

7

There's a type declaration for express-session on DefinitelyTyped:

https://github.com/borisyankov/DefinitelyTyped/blob/master/express-session/express-session.d.ts

Following the pattern in that file, you can create a new d.ts (call it whatever you want) containing:

declare module Express {
  export interface Session {
    returnTo: string;
  }
}

TypeScript will "merge" this extra property into the existing definitions.

edited Jul 9, 2015 at 7:04

answered Jul 8, 2015 at 21:53

Daniel Earwicker

117k38 gold badges209 silver badges289 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Joseph Over a year ago

I tried adding this definition into my // comment area above, but still get an error: src/server/controllers/sessionsController.ts(39,32): error TS2339: Property 'returnTo' does not exist on type 'Session'.

Joseph Over a year ago

I get it - you have to have this definition in an external file. That works fine. Thanks!

Daniel Earwicker Over a year ago

That's right - stuff you declare in a module with exports/imports will not be global, and so won't merge with a pre-existing global declaration.

Camilo Azula · Accepted Answer · 2016-11-10 19:55:15Z

3

Just create a generic T and passed instead of request

<T extends {session: {user: any}}, Request>(sessionRequest: T) => {}

answered Nov 10, 2016 at 19:55

Camilo Azula

312 bronze badges

Collectives™ on Stack Overflow

how to declare typescript interface extension to node request session object?

2 Answers 2

3 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

Comments

Your Answer

Sign up or log in

Post as a guest