Setu-TS
    Preparing search index...

    Interface OutboxRecord

    One outbox row. Every field is a JSON scalar, so the row is portable to every backend the store supports (times are epoch milliseconds, never a Date).

    Optional fields are ABSENT when they carry no value, never undefined.

    0.9.0

    interface OutboxRecord {
        attempts: number;
        availableAt: number;
        claimVersion: number;
        createdAt: number;
        envelope: string;
        id: string;
        kind: "setu-outbox";
        lastError?: string;
        leaseUntil: number;
        options: string;
        orderingKey?: string;
        position: string;
        sentBy?: string;
        settledAt?: number;
        status: OutboxStatus;
        tenantId?: string;
        topic: string;
        traceparent?: string;
    }
    Index
    attempts availableAt claimVersion createdAt envelope id kind lastError? leaseUntil options orderingKey? position sentBy? settledAt? status tenantId? topic traceparent?
    attempts: number

    Publish attempts recorded.

    availableAt: number

    Epoch milliseconds before which the relay must not retry the row.

    claimVersion: number

    Monotonic claim counter; claimable in [0, Number.MAX_SAFE_INTEGER - 1].

    0.9.0

    createdAt: number

    Epoch milliseconds at write — the real time, used for age.

    envelope: string

    JSON.stringify of the envelope, built at write time.

    id: string

    The envelope id — the primary key.

    kind: "setu-outbox"

    The discriminator, always OUTBOX_RECORD_KIND.

    lastError?: string

    The last publish failure, one bounded line. Absent when none.

    leaseUntil: number

    Claim expiry in epoch milliseconds; zero when unclaimed.

    0.9.0

    options: string

    JSON.stringify of the EFFECTIVE publish options ({ orderingKey?, deduplicationId, headers? }).

    orderingKey?: string

    The effective ordering key, duplicated out of options because the relay blocks on it. Absent when the event has none.

    position: string

    The one ordering column: 15 decimal digits of clamped milliseconds followed by the envelope id's 32 lowercase hex characters, with no separators.

    sentBy?: string

    <relay instance id>/<scheduled | dispatch> of the sweep that sent the row. Absent until sent.

    settledAt?: number

    Epoch milliseconds the row became sent or discarded; the retention clock. Absent until then.

    status: OutboxStatus

    The row's lifecycle status.

    tenantId?: string

    The tenant the writer named. Absent when none.

    topic: string

    The integration-event definition's topic.

    traceparent?: string

    The W3C traceparent active at write time. Absent when none.

    Settings
    Member Visibility

    On This Page
    Properties