Cursors

Classes

AbsolutePosition

Cursor

Methods

static compareCursors(a, b)

Parameters:
Name Type Description
a Cursor | null
b Cursor | null

static createAbsolutePosition(type, offset)

Parameters:
Name Type Description
type AbstractType.<any>
offset number

static createAbsolutePositionFromCursor(cursor, y) → {AbsolutePosition|null}

Parameters:
Name Type Description
cursor Cursor
y Y
Returns:
AbsolutePosition | null

static createCursor(type, item)

Parameters:
Name Type Description
type AbstractType.<any>
item ID | null

static createCursorFromJSON(json) → {Cursor}

Parameters:
Name Type Description
json Object
Returns:
Cursor

static createCursorFromTypeOffset(type, offset) → {Cursor}

Create a relativePosition based on a absolute position.

Parameters:
Name Type Description
type AbstractType.<any>

The base type (e.g. YText or YArray).

offset number

The absolute position.

Returns:
Cursor

static readCursor(decoder, y, store) → {Cursor|null}

Parameters:
Name Type Description
decoder decoding.Decoder
y Y
store StructStore
Returns:
Cursor | null

static writeCursor(encoder, rpos)

Parameters:
Name Type Description
encoder encoding.Encoder
rpos Cursor