Class UndoStore

constructor

• new UndoStore(data): UndoStore

• Parameters

  • data: ModelPropsToTransformedCreationData<{
        redoEvents: OptionalModelProp<UndoEvent[]>;
        undoEvents: OptionalModelProp<UndoEvent[]>;
    }>

  Returns UndoStore

Readonly $

Readonly $modelType

[fromSnapshotOverrideTypeSymbol]

[modelIdPropertyNameSymbol]

[propsTypeSymbol]

[toSnapshotOverrideTypeSymbol]

redoEvents

undoEvents

$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

  • newId: ModelIdPropertyType<TProps, ModelIdPropertyName>

  Returns void

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

  • Optional options: {
        withData?: boolean;
    }

    • Optional withData?: 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.