Interface OutboxEnqueueInput

Input for enqueueing a raw outbox message.

interface OutboxEnqueueInput {
    availableAt?: Date;
    id?: string;
    kind: OutboxMessageKind;
    maxAttempts?: number;
    name: string;
    payload: OutboxJsonValue;
    trace?: TraceCarrier;
}

Index

Properties

availableAt? id? kind maxAttempts? name payload trace?

Properties

`Optional`availableAt

availableAt?: Date

Earliest time the message may be claimed.

`Optional`id

id?: string

Optional caller-provided message ID.

kind

kind: OutboxMessageKind

Message kind.

`Optional`maxAttempts

maxAttempts?: number

Maximum delivery attempts before dead-lettering.

name

name: string

Event or job name.

payload

payload: OutboxJsonValue

JSON-serializable payload.

`Optional`trace

trace?: TraceCarrier

Versioned trace context captured when the message was recorded.