"listmodel/index" | @anchor-logoot/logootish-js

file: This file contains the bulky position manipulation logic for any list- based CRDT (arrays, text, rich text, etc.)
author: Nathan Pennie kb1rd@kb1rd.net

Index

Classes

Type aliases

Functions

Type aliases

InsertionOperation

InsertionOperation: { length: number; offset: number; start: number; type: "i" }

Type declaration

length: number
offset: number
start: number
type: "i"

LdmOptions

LdmOptions: { agressively_test_bst?: boolean; disable_conflicts?: boolean }

Type declaration

Optional agressively_test_bst?: boolean

An option that will run tests on the DBST after every operation to it. DO NOT enable in production.
Optional disable_conflicts?: boolean

Disables detection of conflicts. Conflicts will still be present, but mark operations will not be performed and the processing overhead will be eliminated.

MarkOperation

MarkOperation: { conflicting: boolean; length: number; start: number; type: "m" }

Type declaration

conflicting: boolean
length: number
start: number
type: "m"

Operation

Operation: RemovalOperation | InsertionOperation | MarkOperation

An operation returned by _mergeNode to be run on the local document.

Removal

Removal: { clk: LogootInt; length: number; start: LogootPosition }

A Logoot removal.

Type declaration

clk: LogootInt
length: number
start: LogootPosition

RemovalOperation

RemovalOperation: { length: number; start: number; type: "r" }

Type declaration

length: number
start: number
type: "r"

SkipRangeSearch

SkipRangeSearch: { end: LogootPosition; start: LogootPosition }

Type declaration

end: LogootPosition
start: LogootPosition

Functions

conflictOverNodesInRange

conflictOverNodesInRange(last: AnchorLogootNode, skip_ranges: AnchorLogootNode[], level: number, backwards: boolean): void

- Defined in src/listmodel/index.ts:502
Parameters
- last: AnchorLogootNode
- skip_ranges: AnchorLogootNode[]
- level: number
- backwards: boolean
Returns void

constructSkipRanges

constructSkipRanges(bst: DBst<AnchorLogootNode>, __namedParameters: { end: LogootPosition; start: LogootPosition }, bstadd?: (n: AnchorLogootNode) => void): { greater: AnchorLogootNode; lesser: AnchorLogootNode; skip_ranges: AnchorLogootNode[] }

- Defined in src/listmodel/index.ts:155
Parameters
- bst: DBst<AnchorLogootNode>
- __namedParameters: { end: LogootPosition; start: LogootPosition }
  - end: LogootPosition
  - start: LogootPosition
- Default value bstadd: (n: AnchorLogootNode) => void = (n: AnchorLogootNode): AnchorLogootNode => bst.add(n)
  - - (n: AnchorLogootNode): void
    - Parameters
      - n: AnchorLogootNode
      Returns void
Returns { greater: AnchorLogootNode; lesser: AnchorLogootNode; skip_ranges: AnchorLogootNode[] }
- greater: AnchorLogootNode
- lesser: AnchorLogootNode
- skip_ranges: AnchorLogootNode[]

fillRangeConflicts

fillRangeConflicts(nl_lesser: AnchorLogootNode, nl_greater: AnchorLogootNode, range: AnchorLogootNode[], bstadd: (n: AnchorLogootNode) => void): void

- Defined in src/listmodel/index.ts:418
When new nodes are added, their conflicts are not immediately populated. This function fixes that issue by populating each node's conflcits based on that of its neighbors. This should not be relied upon to add conflicts from changed anchors, only from existing anchors from other parts of the document.

Parameters
- nl_lesser: AnchorLogootNode
  
  Node less than range
- nl_greater: AnchorLogootNode
  
  Node greater than range
- range: AnchorLogootNode[]
  
  The range of nodes to fix
- bstadd: (n: AnchorLogootNode) => void
  
  Add a new node to the BST node (if a node is split)
  - - (n: AnchorLogootNode): void
    - Parameters
      - n: AnchorLogootNode
      Returns void
Returns void

fillSkipRanges

fillSkipRanges(left: LogootPosition, right: LogootPosition, start: LogootPosition, clk: LogootInt, type: NodeType, skip_ranges: AnchorLogootNode[], opbuf: OperationBuffer, onnewnode: (n: AnchorLogootNode) => void): AnchorLogootNode[]

- Defined in src/listmodel/index.ts:213
Parameters
- left: LogootPosition
- right: LogootPosition
- start: LogootPosition
- clk: LogootInt
- type: NodeType
- skip_ranges: AnchorLogootNode[]
- opbuf: OperationBuffer
- onnewnode: (n: AnchorLogootNode) => void
  - - (n: AnchorLogootNode): void
    - Parameters
      - n: AnchorLogootNode
      Returns void
Returns AnchorLogootNode[]

insertTrailingConflicts

insertTrailingConflicts(filled_skip_ranges: AnchorLogootNode[], bstadd: (n: AnchorLogootNode) => void): void

- Defined in src/listmodel/index.ts:446
Adds the trailing conflicts off the start and end of the range based on the first and last filled_skip_ranges. This recursively traverses the BST.

Parameters
- filled_skip_ranges: AnchorLogootNode[]
  
  Filled in skip ranges with new nodes
- bstadd: (n: AnchorLogootNode) => void
  
  Add a new node to the BST if a node is split
  - - (n: AnchorLogootNode): void
    - Parameters
      - n: AnchorLogootNode
      Returns void
Returns void

linkFilledSkipRanges

linkFilledSkipRanges(left: LogootPosition, right: LogootPosition, filled_skip_ranges: AnchorLogootNode[], level: number): void

- Defined in src/listmodel/index.ts:287
Parameters
- left: LogootPosition
- right: LogootPosition
- filled_skip_ranges: AnchorLogootNode[]
- level: number
Returns void

reduceInferredRangeAnchors

reduceInferredRangeAnchors(lesser: AnchorLogootNode, filled_skip_ranges: AnchorLogootNode[], greater: AnchorLogootNode): void

- Defined in src/listmodel/index.ts:315
Parameters
- lesser: AnchorLogootNode
- filled_skip_ranges: AnchorLogootNode[]
- greater: AnchorLogootNode
Returns void

Index

Classes

Type aliases

Functions

Type aliases

InsertionOperation

Type declaration

length: number

offset: number

start: number

type: "i"

LdmOptions

Type declaration

Optional agressively_test_bst?: boolean

Optional disable_conflicts?: boolean

MarkOperation

Type declaration

conflicting: boolean

length: number

start: number

type: "m"

Operation

Removal

Type declaration

clk: LogootInt

length: number

start: LogootPosition

RemovalOperation

Type declaration

length: number

start: number

type: "r"

SkipRangeSearch

Type declaration

end: LogootPosition

start: LogootPosition

Functions

conflictOverNodesInRange

Parameters

last: AnchorLogootNode

skip_ranges: AnchorLogootNode[]

level: number

backwards: boolean

Returns void

constructSkipRanges

Parameters

bst: DBst<AnchorLogootNode>

__namedParameters: { end: LogootPosition; start: LogootPosition }

end: LogootPosition

start: LogootPosition

Default value bstadd: (n: AnchorLogootNode) => void = (n: AnchorLogootNode): AnchorLogootNode => bst.add(n)

Parameters

n: AnchorLogootNode

Returns void

Returns { greater: AnchorLogootNode; lesser: AnchorLogootNode; skip_ranges: AnchorLogootNode[] }

greater: AnchorLogootNode

lesser: AnchorLogootNode

skip_ranges: AnchorLogootNode[]

fillRangeConflicts

Parameters

nl_lesser: AnchorLogootNode

nl_greater: AnchorLogootNode

range: AnchorLogootNode[]

bstadd: (n: AnchorLogootNode) => void

Parameters

n: AnchorLogootNode

Returns void

Returns void

fillSkipRanges

Parameters

left: LogootPosition

right: LogootPosition

start: LogootPosition

clk: LogootInt

type: NodeType

skip_ranges: AnchorLogootNode[]

opbuf: OperationBuffer

onnewnode: (n: AnchorLogootNode) => void

Parameters

n: AnchorLogootNode