ICursorSequence

Defined in: packages/data/src/cursor/icursor-sequence.ts:12

Forward-only cursor editing — the shape a singly-linked list can honour.

Extended by

• IBidirectionalCursorSequence

Type Parameters

T

T extends DefinedValue = DefinedValue

The type of elements in the sequence. Anything except undefined.

C

C extends ICursor<T> = ICursor<T>

The cursor type this sequence produces.

Methods

begin()

begin(): C

Defined in: packages/data/src/cursor/icursor-sequence.ts:17

The first element; invalid when empty.

Returns

C

---

cursorAt()

cursorAt(index): C

Defined in: packages/data/src/cursor/icursor-sequence.ts:23

O(1) for random-access backings, O(n) otherwise.

Parameters

index

number

Returns

C

---

end()

end(): C

Defined in: packages/data/src/cursor/icursor-sequence.ts:20

The past-the-end position, used to append.

Returns

C

---

insertAfter()

insertAfter(cursor, item): void

Defined in: packages/data/src/cursor/icursor-sequence.ts:31

Inserts an item after cursor. O(1).

Parameters

cursor

C

The position after which to insert.

item

T

The item to insert.

Returns

void

---

insertAllAfter()

insertAllAfter(cursor, items): void

Defined in: packages/data/src/cursor/icursor-sequence.ts:40

Inserts every item after cursor, keeping their relative order. O(n) in the number of items.

Parameters

cursor

C

The position after which to insert.

items

readonly T[]

The items to insert.

Returns

void

---

removeAfter()

removeAfter(cursor): T | undefined

Defined in: packages/data/src/cursor/icursor-sequence.ts:49

Removes the element after cursor. O(1). Cursors at the removed element become invalid.

Parameters

cursor

C

The position before the element to remove.

Returns

T | undefined

The removed element, or undefined if there was none.

---

setAt()

setAt(cursor, item): void

Defined in: packages/data/src/cursor/icursor-sequence.ts:57

Replaces the element at cursor.

Parameters

cursor

C

The position to replace.

item

T

The new item.

Returns

void