@bluelibs/runner - v6.3.3
    Preparing search index...

    Type Alias DisposeOptions

    Shutdown timing controls for run(..., { dispose }).

    type DisposeOptions = {
        abortWindowMs?: number;
        cooldownWindowMs?: number;
        drainingBudgetMs?: number;
        totalBudgetMs?: number;
    }
    Index

    Properties

    abortWindowMs?: number

    Optional bounded cooperative-abort window after graceful drain expires. Runner aborts its tracked task-local signals, then waits up to this window for in-flight business work to settle. Effective wait is capped by remaining dispose.totalBudgetMs. When drainingBudgetMs is 0, this can still run immediately after the initial drain check. Set to 0 to skip this phase.

    cooldownWindowMs?: number

    Short bounded post-cooldown window before disposing begins. Runner keeps the broader coolingDown admission policy open during this window before switching to the stricter disposing allowlist. Set to 0 to skip this wait.

    drainingBudgetMs?: number

    Drain budget (milliseconds) used while waiting for in-flight business work (tasks + event listeners) after entering disposing. Effective wait is capped by remaining dispose.totalBudgetMs. Set to 0 to skip drain waiting. Runner still performs an immediate drain check, so when work remains in flight and abortWindowMs > 0, shutdown can enter the cooperative-abort phase right away.

    totalBudgetMs?: number

    Total disposal budget (milliseconds) for the shutdown lifecycle. This budget covers cooldown(), the post-cooldown window, disposing hooks, drain wait, drained hooks, and resource disposal. Once exhausted, Runner stops waiting and returns.