Skip to main content

JetstreamRecord<TData>

Defined in: src/client/jetstream.record.ts:20

Immutable message record for JetStream transport.

Compatible with NestJS record builder pattern (like RmqRecord, NatsRecord). Pass as the second argument to client.send() or client.emit().

Example​

const record = new JetstreamRecordBuilder({ id: 1 })
  .setHeader('x-tenant', 'acme')
  .setTimeout(5000)
  .build();

client.send('get.user', record);

Type Parameters​

TData​

TData = unknown

Constructors​

Constructor​

new JetstreamRecord<TData>(data, headers, timeout?, messageId?, schedule?): JetstreamRecord<TData>

Defined in: src/client/jetstream.record.ts:21

Parameters​

data​

TData

Message payload.

headers​

ReadonlyMap<string, string>

Custom headers set via JetstreamRecordBuilder.setHeader.

timeout?​

number

Per-request RPC timeout override in ms.

messageId?​

string

Custom message ID for JetStream deduplication.

schedule?​

ScheduleRecordOptions

Schedule options for delayed delivery.

Returns​

JetstreamRecord<TData>

Properties​

data​

readonly data: TData

Defined in: src/client/jetstream.record.ts:23

Message payload.

headers​

readonly headers: ReadonlyMap<string, string>

Defined in: src/client/jetstream.record.ts:25

Custom headers set via JetstreamRecordBuilder.setHeader.

messageId?​

readonly optional messageId?: string

Defined in: src/client/jetstream.record.ts:29

Custom message ID for JetStream deduplication.

schedule?​

readonly optional schedule?: ScheduleRecordOptions

Defined in: src/client/jetstream.record.ts:31

Schedule options for delayed delivery.

timeout?​

readonly optional timeout?: number

Defined in: src/client/jetstream.record.ts:27

Per-request RPC timeout override in ms.