Saxonberg Server API
    Preparing search index...

    Interface RecurringOptions

    interface RecurringOptions {
        initialDelayMs?: number;
        mode?: "fixed-rate" | "fixed-delay";
        propagateAttribution?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    initialDelayMs? mode? propagateAttribution?

    Properties

    initialDelayMs?: number

    Optional initial delay before the first fire. Defaults to intervalMs (first fire after one full interval). Set to 0 for fire-now-then-recur semantics.

    mode?: "fixed-rate" | "fixed-delay"

    Drift handling.

    • fixed-delay (default): next fire = previous-completion + interval. Drift-tolerant; cadence depends on callback runtime.
    • fixed-rate: next fire = scheduled-time + N*interval. Predictable cadence; if callback runs long, fires can pile up.
    propagateAttribution?: boolean

    When true (default), captures ExecutionContextApi.getCurrentCausingCommandId() at schedule time and restores it on a Root frame for the callback. When false, the callback runs with no command attribution — the chain is severed.

    Settings

    Member Visibility

    On This Page

    Properties