Class UndoManager

constructor

• new UndoManager(disposer, subtreeRoot, store?, options): UndoManager

• Creates an instance of UndoManager. Do not use directly, use undoMiddleware instead.

  Parameters

  • disposer: ActionMiddlewareDisposer
  • subtreeRoot: object
  • Optional store: UndoStore
  • options: undefined | UndoMiddlewareOptions<unknown>

  Returns UndoManager

Readonly store

canRedo

• get canRedo(): boolean

• If redo can be performed (if there is at least one redo action available)

  Returns boolean

canUndo

• get canUndo(): boolean

• If undo can be performed (if there is at least one undo action available).

  Returns boolean

isUndoRecordingDisabled

• get isUndoRecordingDisabled(): boolean

• Returns if undo recording is currently disabled or not for this particular UndoManager.

  Returns boolean

redoLevels

• get redoLevels(): number

• The number of redo actions available.

  Returns number

redoQueue

• get redoQueue(): readonly UndoEvent[]

• The redo stack, where the first operation to redo will be the last of the array. Do not manipulate this array directly.

  Returns readonly UndoEvent[]

undoLevels

• get undoLevels(): number

• The number of undo actions available.

  Returns number

undoQueue

• get undoQueue(): readonly UndoEvent[]

• The undo stack, where the first operation to undo will be the last of the array. Do not manipulate this array directly.

  Returns readonly UndoEvent[]

clearRedo

• clearRedo(): void

• Clears the redo queue.

  Returns void

clearUndo

• clearUndo(): void

• Clears the undo queue.

  Returns void

createGroup

• createGroup(groupName?): {
      continue<T>(fn): T;
      end(): void;
  }

• Creates a custom group that can be continued multiple times and then ended.

  Parameters

  • Optional groupName: string

    Optional group name.

  Returns {
      continue<T>(fn): T;
      end(): void;
  }

  An API to continue/end the group.

  • continue:function

    • continue<T>(fn): T

    • Type Parameters

      • T

      Parameters

      • fn: (() => T)
        • • (): T

          • Returns T

      Returns T

  • end:function

    • end(): void

    • Returns void

dispose

• dispose(): void

• Disposes the undo middleware.

  Returns void

redo

• redo(): void

• Redoes the previous action. Will throw if there is no action to redo.

  Returns void

undo

• undo(): void

• Undoes the last action. Will throw if there is no action to undo.

  Returns void

withGroup

• withGroup<T>(groupName, fn): T

• Runs a synchronous code block as an undo group. Note that nested groups are allowed.

  Type Parameters

  • T

  Parameters

  • groupName: string

    Group name.
  • fn: (() => T)

    Code block.

    • • (): T

      • Returns T

  Returns T

  Code block return value.
• withGroup<T>(fn): T

• Runs a synchronous code block as an undo group. Note that nested groups are allowed.

  Type Parameters

  • T

  Parameters

  • fn: (() => T)

    Code block.

    • • (): T

      • Returns T

  Returns T

  Code block return value.

withGroupFlow

• withGroupFlow<R>(groupName, fn): Promise<R>

• Runs an asynchronous code block as an undo group. Note that nested groups are allowed.

  Type Parameters

  • R

  Parameters

  • groupName: string

    Group name.
  • fn: (() => Generator<any, R, any>)

    Flow function.

    • • (): Generator<any, R, any>

      • Returns Generator<any, R, any>

  Returns Promise<R>

  Flow function return value.
• withGroupFlow<R>(fn): Promise<R>

• Runs an asynchronous code block as an undo group. Note that nested groups are allowed.

  Type Parameters

  • R

  Parameters

  • fn: (() => Generator<any, R, any>)

    Flow function.

    • • (): Generator<any, R, any>

      • Returns Generator<any, R, any>

  Returns Promise<R>

  Flow function return value.

withoutUndo

• withoutUndo<T>(fn): T

• Skips the undo recording mechanism for the code block that gets run synchronously inside.

  Type Parameters

  • T

  Parameters

  • fn: (() => T)

    Code block to run.

    • • (): T

      • Returns T

  Returns T

  The value returned by the code block.

  Typeparam

  T Code block return type.