State

@tsed/platform-koa

Usage

import { State } from "@tsed/platform-koa";

See /packages/platform/platform-koa/src/types/decorators/state.ts.

Overview

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

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

Description

State return the value from koa.ctx.state object.

Example

@Middleware()
class StateMiddleware {
  use(@State() state: any) {
     // set some on locals
     state.user = "user"
  }
}

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

      return {
        description: 'Hello world'
      }
   }
}