IBidirectionalCursor
Defined in: packages/data/src/cursor/ibidirectional-cursor.ts:6
A cursor over a sequence that can also be walked backward.
Extends
Section titled “Extends”ICursor<T>
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”T extends DefinedValue = DefinedValue
Properties
Section titled “Properties”
readonlyvalid:boolean
Defined in: packages/data/src/cursor/icursor.ts:16
False once moved past the end, or once its element was removed.
Inherited from
Section titled “Inherited from”
readonlyvalue:T|undefined
Defined in: packages/data/src/cursor/icursor.ts:19
The element at this position, undefined when not valid.
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”advance()
Section titled “advance()”advance():
boolean
Defined in: packages/data/src/cursor/icursor.ts:26
Moves one position forward.
Returns
Section titled “Returns”boolean
false if that moved past the end.
Inherited from
Section titled “Inherited from”clone()
Section titled “clone()”clone():
IBidirectionalCursor<T>
Defined in: packages/data/src/cursor/ibidirectional-cursor.ts:16
An independent cursor at the same position.
Returns
Section titled “Returns”IBidirectionalCursor<T>
Overrides
Section titled “Overrides”retreat()
Section titled “retreat()”retreat():
boolean
Defined in: packages/data/src/cursor/ibidirectional-cursor.ts:14
Moves one position back.
Returns
Section titled “Returns”boolean
false if that moved before the start.