CorrelationFrom

const CorrelationFrom: object

Defined in: decorators/with-correlation.decorator.ts:257

Pre-built extraction presets for WithCorrelation, for transports whose handlers receive the correlation id in metadata rather than in the payload.

For transports that carry it in the payload (BullMQ, PostgreSQL NOTIFY), use the bare @WithCorrelation() or a path; for any other shape, an extract function.

Type Declaration

grpc

readonly grpc: (key) => CorrelationDecoratorOptions

gRPC — extracts from gRPC Metadata (second argument).

In gRPC handlers the signature is (data, metadata, call).

Parameters

key?

string = DEFAULT_CORRELATION_HEADER

Metadata key. Defaults to 'x-correlation-id'.

Returns

CorrelationDecoratorOptions

Example

class Users {
  // gRPC (@grpc/grpc-js): (request, metadata)
  @WithCorrelation(CorrelationFrom.grpc())
  async findOne(request: FindOneRequest, metadata: Metadata) {}
}