inheritree
    Preparing search index...

    Interface Path<TKey, TEntry>

    Public, insulated view of a cursor in a BTree. Exposes only what a consumer can safely touch; the structural fields (branches / leafNode / leafIndex / version) live on the concrete PathImpl and are deliberately kept off this interface so they can't be corrupted by accident. A path is invalid once the tree has been mutated (unless it is itself the result of a mutation method) - see BTree.isValid.

    on - true if the cursor is on an entry, false if it is between entries ("in a crack").

    interface Path<TKey, TEntry> {
        on: boolean;
        clone(): Path<TKey, TEntry>;
        isEqual(other: Path<TKey, TEntry>): boolean;
    }

    Type Parameters

    • TKey
    • TEntry
    Index

    Properties

    on

    Methods

    clone isEqual

    Properties

    on: boolean

    true if the cursor is on an entry; false if it sits in a "crack" between entries.

    Methods

    • Parameters

      Returns boolean

      true if the other path is positioned identically (same leaf, index, on-state and tree version).

    Settings

    Member Visibility

    On This Page

    Properties
    Methods