Beignet API reference
    Preparing search index...

    Type Alias CreateNextOutboxDrainTriggerOptions<Ctx>

    Options for scheduling a bounded outbox drain after a successful request transaction.

    type CreateNextOutboxDrainTriggerOptions<Ctx extends OutboxDrainContext> = {
        batchSize?: number;
        concurrency?: number;
        createContext: () => MaybePromise<Ctx>;
        defer: NextDeferredWorkScheduler;
        heartbeatMs?: number;
        leaseMs?: number;
        maxActiveMs?: number;
        onError?: (error: unknown) => MaybePromise<void>;
        registry: OutboxRegistry | (() => MaybePromise<OutboxRegistry>);
        retryDelayMs?: DrainOutboxOptions["retryDelayMs"];
    }

    Type Parameters

    • Ctx extends OutboxDrainContext
    Index
    batchSize? concurrency? createContext defer heartbeatMs? leaseMs? maxActiveMs? onError? registry retryDelayMs?
    batchSize?: number

    Maximum eligible messages to handle in the deferred drain pass.

    concurrency?: number

    Maximum messages delivered concurrently. Values above one are unordered.

    createContext: () => MaybePromise<Ctx>

    Build the service context used by the deferred drain.

    defer: NextDeferredWorkScheduler

    Schedule work after the response, usually with next/server's after.

    heartbeatMs?: number

    Serialized claim-renewal interval. Must remain shorter than leaseMs.

    leaseMs?: number

    Claim lease duration in milliseconds.

    maxActiveMs?: number

    Maximum time Beignet renews a claim for one delivery.

    onError?: (error: unknown) => MaybePromise<void>

    Best-effort observer for scheduler, context, registry, or drain failures. Observer failures are ignored.

    registry: OutboxRegistry | (() => MaybePromise<OutboxRegistry>)

    Static registry or lazy loader used to avoid server/provider cycles.

    retryDelayMs?: DrainOutboxOptions["retryDelayMs"]

    Retry delay override passed through to drainOutbox(...).

    Settings
    Member Visibility

    On This Page
    Properties