Setu-TS
    Preparing search index...

    Interface OutboxCommonOptions

    Options shared by both store forms of OutboxOptions.

    0.9.0

    interface OutboxCommonOptions {
        background?: (promise: Promise<unknown>) => void;
        health?: OutboxHealthOptions;
        maxEnvelopeBytes?: number;
        purgeBatch?: number;
        purgeIntervalMs?: number;
        relay?: OutboxRelayOptions;
        retainSentMs?: number;
    }
    Index
    background? health? maxEnvelopeBytes? purgeBatch? purgeIntervalMs? relay? retainSentMs?
    background?: (promise: Promise<unknown>) => void

    Receives the promise of a sweep dispatch() requests. Default: detached, with a rejection logged. On Cloudflare Workers pass waitUntil.

    health?: OutboxHealthOptions

    Health thresholds.

    maxEnvelopeBytes?: number

    Largest serialized envelope write accepts, in UTF-8 bytes. Default 262144.

    purgeBatch?: number

    Rows deleted per status per purge run. Default 100.

    purgeIntervalMs?: number

    Milliseconds between purge runs. Default 60000.

    relay?: OutboxRelayOptions

    The relay schedule, budgets and failure policy.

    retainSentMs?: number

    How long sent and discarded rows are kept. Default 7 days. 0 deletes a row at mark-sent, which also disables overlap detection.

    Settings
    Member Visibility

    On This Page
    Properties