mobx-keystone
    Preparing search index...

    Interface PatchRecorderOptions

    Patch recorder options.

    interface PatchRecorderOptions {
        filter?: (patches: Patch[], inversePatches: Patch[]) => boolean;
        onPatches?: OnPatchesListener;
        recording?: boolean;
    }
    Index

    Properties

    filter? onPatches? recording?

    Properties

    filter?: (patches: Patch[], inversePatches: Patch[]) => boolean

    An optional callback filter to select wich patches to record/skip. It will be executed before the event is added to the events list.

    Type declaration

      • (patches: Patch[], inversePatches: Patch[]): boolean

      • Parameters

        • patches: Patch[]

          Patches about to be recorded.

        • inversePatches: Patch[]

          Inverse patches about to be recorded.

        Returns boolean

        true to record the patch, false to skip it.

    onPatches?: OnPatchesListener

    An optional callback run once a patch is recorded. It will be executed after the event is added to the events list.

    Patches just recorded.

    Inverse patches just recorded.

    recording?: boolean

    If the patch recorder is initially recording when created.

    Settings

    Member Visibility

    On This Page

    Properties