API reference / @chanx-js/nestjs / Payload

Function: Payload()

Call Signature

function Payload(...pipes): ParameterDecorator;

Defined in: packages/nestjs/src/decorators.ts:119

The message's payload, or one of its properties, through any pipes, as @MessageBody(): @Payload(), @Payload('text'), @Payload(new ValidationPipe()).

Parameters

Parameter	Type
...pipes	Pipe[]

Returns

ParameterDecorator

Call Signature

function Payload(property, ...pipes): ParameterDecorator;

Defined in: packages/nestjs/src/decorators.ts:120

The message's payload, or one of its properties, through any pipes, as @MessageBody(): @Payload(), @Payload('text'), @Payload(new ValidationPipe()).

Parameters

Parameter	Type
property	string
...pipes	Pipe[]

Returns

ParameterDecorator