Locals

@tsed/platform-params

Usage

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

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

Overview

function Locals(expression: string): ParameterDecorator;
export function Locals(): ParameterDecorator;

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

Description

Locals return the value from response.locals object.

TIP

Locals are generally used by express and third-party like templating engine to render a page/template. See Templating section for more details.

Example

@Middleware()
class LocalsMiddleware {
  use(@Locals() locals: any) {
     // set some on locals
     locals.user = "user"
  }
}

@Controller('/')
@UseBefore(LocalsMiddleware)
class MyCtrl {
   @Get('/')
   @View('home.ejs') // will use locals and returned data to render the page
   get(@Locals('user') user: any) {
      console.log('user', user);

      return {
        description: 'Hello world'
      }
   }
}