Class Cursors

Utilities for working with Cursors.

Hierarchy

Cursors

Index

Methods

Methods

Static fromIndex

fromIndex(index: number, list: ICursorList): string

- Defined in core/build/esm/src/util/cursors.d.ts:59
Returns the Cursor at index within the given list. Invert with toIndex.

That is, the cursor is between the list elements at index - 1 and index.

Parameters
- index: number
- list: ICursorList
  
  The target list.
Returns string

Static toIndex

toIndex(cursor: string, list: ICursorList): number

- Defined in core/build/esm/src/util/cursors.d.ts:68
Returns the current index of cursor within the given list. Inverse of fromIndex.

That is, the cursor is between the list elements at index - 1 and index.

Parameters
- cursor: string
  
  The Cursor.
- list: ICursorList
  
  The target list.
Returns number

Generated using TypeDoc