Session

@tsed/platform-params

Usage

import { Session } from "@tsed/platform-params";

See /packages/platform/platform-params/src/types/decorators/session.ts.

Overview

function Session(expression: string): ParameterDecorator;
export function Session(options: Partial<ParamOptions>): ParameterDecorator;
export function Session(): ParameterDecorator;

• expression (string): The path of the property to get.

Description

Session return the value from request.session object.

Example

@Controller('/')
class MyCtrl {
   @Post('/')
   create(@Session() session: Express.Session) {
      console.log('Entire session', session);
   }

   @Post('/')
   create(@Session('id') id: string) {
      console.log('ID', id);
   }

   @Post('/') // Example to deserialize use from session
   create(@Session({expression: 'user', useMapper: true}) user: User) {
      console.log('user', user);
      console.log('instanceOf user', user instanceof User);
   }
}

For more information on deserialization see converters page.