Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UndoStore

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

Hierarchy

Index

Constructors

Properties

$: { 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.

Type declaration

$modelType: string

Model type name.

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

Type declaration

[toSnapshotOverrideTypeSymbol]: never
redoEvents: UndoEvent[] = ...
undoEvents: UndoEvent[] = ...

Accessors

  • get $modelId(): [ModelIdPropertyName] extends [never] ? never : string
  • set $modelId(newId: [ModelIdPropertyName] extends [never] ? never : string): void
  • Model internal id. Can be modified inside a model action. It will return undefined if there's no id prop set.

    Returns [ModelIdPropertyName] extends [never] ? never : string

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

    Parameters

    • newId: [ModelIdPropertyName] extends [never] ? never : string

    Returns void

Methods

  • 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(options?: { withData?: boolean }): string
  • toString(): string
  • Parameters

    • Optional options: { withData?: boolean }
      • Optional withData?: boolean

    Returns string

  • Returns a string representation of an object.

    Returns string

  • 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.

Generated using TypeDoc