openmixer — generated API reference
    Preparing search index...

    Interface ResourcePatchResult<S>

    The result of a patch — the write, the projection, the broadcast and the ripples, together.

    ok describes the STATE change. A patch can be ok: true with projection.applied: false: the console changed and the audio did not follow — reported, never flattened.

    interface ResourcePatchResult<S extends object> {
        broadcast?: ResourceBroadcast<S>;
        fault?: ResourceFault;
        ok: boolean;
        preview?: object;
        projection?: ProjectionResult;
        reason?: string;
        refusal?: Refusal;
        rippled?: readonly ResourceBroadcast<object>[];
        state?: S;
    }

    Type Parameters

    • S extends object
    Index
    broadcast? fault? ok preview? projection? reason? refusal? rippled? state?
    broadcast?: ResourceBroadcast<S>

    The frame to broadcast for the patched instance.

    fault?: ResourceFault
    ok: boolean
    preview?: object

    On a CONFIRM_REQUIRED refusal: the preview row's state as a GET answers it — the list the fire was refused over, so a client renders it without a second read.

    projection?: ProjectionResult
    reason?: string
    refusal?: Refusal

    The machine-readable refusal, when the write was refused below the capability gate.

    rippled?: readonly ResourceBroadcast<object>[]

    Frames for the instances the resource declared as ripples of this write, in order.

    state?: S

    Settings
    Member Visibility

    On This Page
    Properties