correlationHeaders
correlationHeaders(
key?):Record<string,string>
Defined in: correlation.store.ts:224
Return a headers object stamped with the current correlation ID.
Use this for header-based transports (Kafka, NATS, gRPC metadata, HTTP) where the correlation ID belongs in message headers / metadata — not in the data payload.
For transports without native headers (Bull/BullMQ, PostgreSQL NOTIFY), use addCorrelationId instead.
Parameters
Section titled “Parameters”string = DEFAULT_CORRELATION_HEADER
Header name. Defaults to 'x-correlation-id'.
Returns
Section titled “Returns”Record<string, string>
{ [key]: correlationId } — spread into your transport’s headers.