Class DBIterator<K, V>

Type Parameters

Hierarchy

  • CreateDestroy
    • DBIterator

Constructors

constructor

Properties

[initLock] _db _iterator _options _transaction? cache cachePos finished first levelPath lock logger

Accessors

[destroyed] [eventHandled] [eventHandlers] [eventTarget] [handleEventError] [statusP] [status] db iterator options transaction

Methods

[asyncIterator] _next addEventListener destroy dispatchEvent next processEntry removeEventListener seek

Constructors

constructor

Properties

Readonly [initLock]

[initLock]: RWLockWriter

Protected _db

_db: DB

Protected _iterator

_iterator: RocksDBIterator<Buffer, Buffer>

Protected _options

_options: Merge<DBIteratorOptions<any>, {
    gt?: Buffer;
    gte?: Buffer;
    keyEncoding: "buffer";
    lt?: Buffer;
    lte?: Buffer;
    valueEncoding: "buffer";
}>

Type declaration

  • Optional gt?: Buffer
  • Optional gte?: Buffer
  • keyEncoding: "buffer"
  • Optional lt?: Buffer
  • Optional lte?: Buffer
  • valueEncoding: "buffer"

Protected Optional _transaction

_transaction?: DBTransaction

Protected cache

cache: [Buffer, Buffer][] = []

Protected cachePos

cachePos: number = 0

Protected finished

finished: boolean = false

Protected first

first: boolean = true

Protected levelPath

levelPath: readonly (string | Buffer)[]

Protected lock

lock: Lock = ...

Protected logger

logger: Logger

Accessors

[destroyed]

  • get [destroyed](): boolean

  • Returns boolean

[eventHandled]

  • get [eventHandled](): ReadonlyWeakSet<Event>

  • Returns ReadonlyWeakSet<Event>

[eventHandlers]

  • get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>

  • Returns ReadonlyMap<string, Set<EventHandlerInfo>>

[eventTarget]

  • get [eventTarget](): EventTarget

  • Returns EventTarget

[handleEventError]

  • get [handleEventError](): ((evt) => void)

  • Returns ((evt) => void)

      • (evt): void

      • Parameters

        • evt: EventError

        Returns void

[statusP]

  • get [statusP](): Promise<Status>

  • Returns Promise<Status>

[status]

  • get [status](): Status

  • Returns Status

db

iterator

options

transaction

Methods

[asyncIterator]

  • [asyncIterator](): AsyncGenerator<[K, V], void, void>

  • Returns AsyncGenerator<[K, V], void, void>

Protected _next

  • _next(): Promise<undefined | [K, V]>

  • Returns Promise<undefined | [K, V]>

addEventListener

  • Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

destroy

  • Returns Promise<void>

dispatchEvent

  • Parameters

    • event: Event

    Returns boolean

next

  • Returns Promise<undefined | [K, V]>

Protected processEntry

  • Parameters

    • entry: [Buffer, Buffer]

    Returns Promise<[K, V]>

removeEventListener

  • Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

seek

  • Parameters

    • keyPath: string | Buffer | readonly (string | Buffer)[]

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc