Class UndoStore

Store model instance for undo/redo actions. Do not manipulate directly, other that creating it.

Hierarchy

Constructors

constructor

Properties

[fromSnapshotOverrideTypeSymbol] [modelIdPropertyNameSymbol] [propsTypeSymbol] [toSnapshotOverrideTypeSymbol] $ $modelType redoEvents undoEvents

Accessors

$modelId

Methods

getRefId toString typeCheck

Constructors

constructor

Properties

[fromSnapshotOverrideTypeSymbol]

[fromSnapshotOverrideTypeSymbol]: never

[modelIdPropertyNameSymbol]

[modelIdPropertyNameSymbol]: never

[propsTypeSymbol]

[propsTypeSymbol]: {
    redoEvents: OptionalModelProp<UndoEvent[]>;
    undoEvents: OptionalModelProp<UndoEvent[]>;
}

[toSnapshotOverrideTypeSymbol]

[toSnapshotOverrideTypeSymbol]: never

Readonly$

$: {
    redoEvents: UndoEvent[];
    undoEvents: UndoEvent[];
}

Data part of the model, which is observable and will be serialized in snapshots. Use it if one of the data properties matches one of the model properties/functions.

Readonly$modelType

$modelType: string

Model type name.

redoEvents

redoEvents: UndoEvent[] = ...

undoEvents

undoEvents: UndoEvent[] = ...

Accessors

$modelId

  • get $modelId(): ModelIdPropertyType<TProps, ModelIdPropertyName>

  • Model internal id. Can be modified inside a model action. It will return undefined if there's no id prop set.

    Returns ModelIdPropertyType<TProps, ModelIdPropertyName>

  • set $modelId(newId): void

  • Parameters

    Returns void

Methods

getRefId

  • getRefId(): undefined | string

  • Can be overridden to offer a reference id to be used in reference resolution. By default it will use the idProp if available or return undefined otherwise.

    Returns undefined | string

toString

  • toString(options?): string

  • Parameters

    • Optionaloptions: {
          withData?: boolean;
      }
      • OptionalwithData?: boolean

    Returns string

typeCheck

  • typeCheck(): null | TypeCheckError

  • Performs a type check over the model instance. For this to work a data type has to be declared as part of the model properties.

    Returns null | TypeCheckError

    A TypeCheckError or null if there is no error.

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods