openmixer — generated API reference
    Preparing search index...

    Interface OperationState<P, R>

    The one operation state shape.

    running is the only wire-writable field; everything else is the mold's or the run's to report. params and report are the two columns an operation may DECLARE (OperationConfig.params / OperationRun.land): what the run was asked to do, and what it found. Both are read-only here — the parameters are written by NAME alongside the fire, never as a params object, so there is one spelling of an argument on the wire.

    interface OperationState<
        P extends object = NoOperationColumn,
        R extends object = NoOperationColumn,
    > {
        params?: Readonly<Partial<P>>;
        progress?: number;
        refusal?: Refusal;
        report?: R;
        running: boolean;
        startedAt?: number;
    }

    Type Parameters

    • P extends object = NoOperationColumn

      the declared parameter shape (NoOperationColumn when the operation takes none)

    • R extends object = NoOperationColumn

      the declared report shape (NoOperationColumn when the run reports nothing)

    Index
    params? progress? refusal? report? running startedAt?
    params?: Readonly<Partial<P>>

    What the current (or last) run was asked to do — the decoded parameters, echoed so a watcher that joined mid-run can see the gesture rather than only that one is happening.

    progress?: number

    The current run's progress in [0, 1], while it is running and reporting.

    refusal?: Refusal

    Why the last landing failed. Absent = the last run landed clean (or never ran).

    report?: R

    What the last landing found. Absent until a run lands with one.

    running: boolean
    startedAt?: number

    When the current (or last) run fired, in the config clock's units.

    Settings
    Member Visibility

    On This Page
    Properties