Beignet API reference
    Preparing search index...

    Interface OutboxMessage

    Durable outbox message record.

    interface OutboxMessage {
        attempts: number;
        availableAt: Date;
        claimedAt: Date | null;
        claimToken: string | null;
        createdAt: Date;
        deliveredAt: Date | null;
        id: string;
        kind: OutboxMessageKind;
        lastError: OutboxErrorInfo | null;
        lockedUntil: Date | null;
        maxAttempts: number;
        name: string;
        payload: OutboxJsonValue;
        status: OutboxMessageStatus;
        updatedAt: Date;
    }
    Index

    Properties

    attempts availableAt claimedAt claimToken createdAt deliveredAt id kind lastError lockedUntil maxAttempts name payload status updatedAt

    Properties

    attempts: number

    Number of claim attempts.

    availableAt: Date

    Earliest time the message may be claimed.

    claimedAt: Date | null

    Last claim timestamp.

    claimToken: string | null

    Token required to mark a claimed message delivered or failed.

    createdAt: Date

    Creation timestamp.

    deliveredAt: Date | null

    Delivery timestamp.

    id: string

    Stable message ID.

    kind: OutboxMessageKind

    Message kind.

    lastError: OutboxErrorInfo | null

    Last delivery error.

    lockedUntil: Date | null

    Lease expiration timestamp for claimed messages.

    maxAttempts: number

    Maximum delivery attempts before dead-lettering.

    name: string

    Event or job name.

    payload: OutboxJsonValue

    JSON-serializable payload.

    status: OutboxMessageStatus

    Current delivery status.

    updatedAt: Date

    Last update timestamp.

    Settings

    Member Visibility

    On This Page

    Properties