Function: Payload()

function Payload(property?): ParameterDecorator;

Defined in: packages/microservices/src/decorators/payload.decorator.ts:21

Extracts the message payload (or a nested property of it) and injects it as a method parameter.

Parameters

Parameter	Type	Description
property?	string	When provided, only the named property of the payload is injected.

Returns

ParameterDecorator

Example

// Inject the full payload
@MessagePattern('sum')
sum(@Payload() data: number[]) { ... }

// Inject a specific property
@MessagePattern('login')
login(@Payload('username') username: string) { ... }