Options
All
  • Public
  • Public/Protected
  • All
Menu

Class STreeNodeCursor<V, I>

Type parameters

  • V

  • I

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new STreeNodeCursor<V, I>(pages: readonly STreePage<V, I>[], index?: number, childIndex?: number, childCursor?: null | Cursor<[I, V]>): STreeNodeCursor<V, I>

  • Type parameters

    • V

    • I

    Parameters

    • pages: readonly STreePage<V, I>[]
    • Optional index: number
    • Optional childIndex: number
    • Optional childCursor: null | Cursor<[I, V]>

    Returns STreeNodeCursor<V, I>

Properties

childCursor

childCursor: null | Cursor<[I, V]>

childIndex

childIndex: number

index

index: number

Readonly pages

pages: readonly STreePage<V, I>[]

Methods

delete

  • delete(): void

  • Returns void

hasNext

  • hasNext(): boolean

  • Returns boolean

hasPrevious

  • hasPrevious(): boolean

  • Returns boolean

head

  • head(): [I, V]

  • Returns [I, V]

isEmpty

  • isEmpty(): boolean

  • Returns boolean

next

  • next(): { done: boolean; value?: [I, V] }

  • Returns { done: boolean; value?: [I, V] }

    • done: boolean
    • Optional value?: [I, V]

nextIndex

  • nextIndex(): number

  • Returns number

Protected pageCursor

  • Parameters

    Returns Cursor<[I, V]>

Protected pageSize

  • Parameters

    Returns number

previous

  • previous(): { done: boolean; value?: [I, V] }

  • Returns { done: boolean; value?: [I, V] }

    • done: boolean
    • Optional value?: [I, V]

previousIndex

  • previousIndex(): number

  • Returns number

Protected reversePageCursor

set

  • set(newValue: [I, V]): void

  • Parameters

    • newValue: [I, V]

    Returns void

skip

  • skip(count: number): void

  • Parameters

    • count: number

    Returns void

step

  • step(): void

  • Returns void

Static array

  • array<T>(array: readonly T[], index?: number, limit?: number): Cursor<T>

  • Type parameters

    • T

    Parameters

    • array: readonly T[]
    • Optional index: number
    • Optional limit: number

    Returns Cursor<T>

Static empty

  • Type parameters

    • T

    Returns Cursor<T>

Static unary

  • unary<T>(value: T): Cursor<T>

  • Type parameters

    • T

    Parameters

    • value: T

    Returns Cursor<T>

Generated using TypeDoc