Beignet API reference
    Preparing search index...

    Interface ClaimedOutboxMessage

    Message returned from a successful outbox claim.

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

    Hierarchy

    • Omit<OutboxMessage, "claimToken" | "claimedAt" | "lockedUntil" | "status">
      • ClaimedOutboxMessage
    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
    claimToken: string
    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
    maxAttempts: number

    Maximum delivery attempts before dead-lettering.

    name: string

    Event or job name.

    payload: OutboxJsonValue

    JSON-serializable payload.

    status: "claimed"
    updatedAt: Date

    Last update timestamp.

    Settings

    Member Visibility

    On This Page

    Properties