vapor-chamber API reference - v1.16.0
    Preparing search index...

    Type Alias OutboxOptions

    type OutboxOptions = {
        actions?: string[];
        storage?: OutboxStorage;
        isOnline?: () => boolean;
        autoFlush?: boolean;
        key?: (cmd: Command) => string;
        maxQueue?: number;
    }
    Index
    actions?: string[]

    Which actions to capture. Glob patterns supported: '', 'cart'. Default: all.

    storage?: OutboxStorage

    Durable queue storage. Default: localStorageOutbox().

    isOnline?: () => boolean

    Connectivity probe, checked per dispatch and per replay step. Default: navigator.onLine when a navigator exists, otherwise true (SSR).

    autoFlush?: boolean

    Listen for the window 'online' event and flush() automatically once a bus ref exists (via install()). Default: true. No timers, no polling — the listener is removed by dispose().

    key?: (cmd: Command) => string

    Derive the idempotency key stored on each record and replayed to the backend. Default: commandKey(action, target) — the same convention the idempotent() plugin uses, so both layers agree on what "the same logical command" means.

    maxQueue?: number

    Max queued records — bounded memory. When exceeded, the OLDEST record is dropped with a console warning. Default: 200.