Class ObservableUndoableList<T>

A concrete implementation of an observable undoable list.

Type Parameters

  • T

Hierarchy (View Summary)

Implements

Constructors

Accessors

Methods

  • Insert a value into the list at a specific index.

    Parameters

    • index: number

      The index at which to insert the value.

    • value: T

      The value to set at the specified index.

      Linear.

      No changes.

      The index will be clamped to the bounds of the list.

      By convention, the oldIndex is set to -2 to indicate an insert operation.

      The value -2 as oldIndex can be used to distinguish from the push method which will use a value -1.

      An index which is non-integral.

    Returns void

  • Insert a set of items into the list at the specified index.

    Parameters

    • index: number

      The index at which to insert the values.

    • values: Iterable<T>

      The values to insert at the specified index.

      Linear.

      No changes.

      The index will be clamped to the bounds of the list. By convention, the oldIndex is set to -2 to indicate an insert operation.

      An index which is non-integral.

    Returns void

  • Move a value from one index to another.

    Parameters

    • fromIndex: number

      The index of the element to move.

    • toIndex: number

      The index to move the element to.

      Constant.

      Iterators pointing at the lesser of the fromIndex and the toIndex and beyond are invalidated.

      A fromIndex or a toIndex which is non-integral.

    Returns void

  • Remove and return the value at a specific index.

    Parameters

    • index: number

      The index of the value of interest.

    Returns undefined | T

    The value at the specified index, or undefined if the index is out of range.

    Constant.

    Iterators pointing at the removed value and beyond are invalidated.

    An index which is non-integral.

  • Remove a range of items from the list.

    Parameters

    • startIndex: number

      The start index of the range to remove (inclusive).

    • endIndex: number

      The end index of the range to remove (exclusive).

    Returns number

    The new length of the list.

    Linear.

    Iterators pointing to the first removed value and beyond are invalid.

    A startIndex or endIndex which is non-integral.