DbIterator

Defined in: .work/repos/olmdb/src/olmdb.ts:329

Database iterator that implements the standard TypeScript iterator protocol

Extends

Iterator<DbEntry<K, V>, undefined>

Type Parameters

K

K

V

V

Implements

Iterator<DbEntry<K, V>, undefined>

Constructors

Constructor

new DbIterator<K, V>(iteratorId, convertKey, convertValue): DbIterator<K, V>

Defined in: .work/repos/olmdb/src/olmdb.ts:333

Parameters

iteratorId

number

convertKey

(buffer) => K

convertValue

(buffer) => V

Returns

DbIterator<K, V>

Overrides

Iterator<DbEntry<K,V>,undefined>.constructor

Properties

[toStringTag]

readonly [toStringTag]: string

Defined in: site/node_modules/typescript/lib/lib.es2025.iterator.d.ts:132

Inherited from

Iterator.[toStringTag]

Methods

[iterator]()

[iterator](): DbIterator<K, V>

Defined in: .work/repos/olmdb/src/olmdb.ts:340

Returns

DbIterator<K, V>

Overrides

Iterator.[iterator]

next()

next(): IteratorResult<DbEntry<K, V>>

Defined in: .work/repos/olmdb/src/olmdb.ts:351

Advances the iterator to the next key-value pair.

Returns

IteratorResult<DbEntry<K, V>>

An IteratorResult with the next DbEntry or done: true if no more entries.

Throws

With code “INVALID_ITERATOR” if iterator is invalid or already closed.

Throws

With code “LMDB-{code}” for LMDB-specific errors.

Implementation of

Iterator.next

Overrides

Iterator.next

close()

close(): void

Defined in: .work/repos/olmdb/src/olmdb.ts:375

Closes the iterator and frees its resources. Should be called when done iterating to prevent resource leaks.

Returns

void

Throws

With code “INVALID_ITERATOR” if iterator is invalid or already closed.

return()?

optional return(value?): IteratorResult<DbEntry<K, V>, undefined>

Defined in: site/node_modules/typescript/lib/lib.es2015.iterable.d.ts:42

Parameters

value?

undefined

Returns

IteratorResult<DbEntry<K, V>, undefined>

Implementation of

Iterator.return

Inherited from

Iterator.return

throw()?

optional throw(e?): IteratorResult<DbEntry<K, V>, undefined>

Defined in: site/node_modules/typescript/lib/lib.es2015.iterable.d.ts:43

Parameters

e?

any

Returns

IteratorResult<DbEntry<K, V>, undefined>

Implementation of

Iterator.throw

Inherited from

Iterator.throw

map()

map<U>(callbackfn): IteratorObject<U, undefined, unknown>

Defined in: site/node_modules/typescript/lib/lib.es2025.iterator.d.ts:48

Creates an iterator whose values are the result of applying the callback to the values from this iterator.

Type Parameters

U

U

Parameters

callbackfn

(value, index) => U

A function that accepts up to two arguments to be used to transform values from the underlying iterator.

Returns

IteratorObject<U, undefined, unknown>

Inherited from

Iterator.map

filter()

Call Signature

filter<S>(predicate): IteratorObject<S, undefined, unknown>

Defined in: site/node_modules/typescript/lib/lib.es2025.iterator.d.ts:54

Creates an iterator whose values are those from this iterator for which the provided predicate returns true.

Type Parameters

S

S extends DbEntry<K, V>

Parameters

predicate

(value, index) => value is S

A function that accepts up to two arguments to be used to test values from the underlying iterator.

Returns

IteratorObject<S, undefined, unknown>

Inherited from

Iterator.filter

Call Signature

filter(predicate): IteratorObject<DbEntry<K, V>, undefined, unknown>

Defined in: site/node_modules/typescript/lib/lib.es2025.iterator.d.ts:60

Creates an iterator whose values are those from this iterator for which the provided predicate returns true.

Parameters

predicate

(value, index) => unknown

A function that accepts up to two arguments to be used to test values from the underlying iterator.

Returns

IteratorObject<DbEntry<K, V>, undefined, unknown>

Inherited from

Iterator.filter

take()

take(limit): IteratorObject<DbEntry<K, V>, undefined, unknown>

Defined in: site/node_modules/typescript/lib/lib.es2025.iterator.d.ts:66

Creates an iterator whose values are the values from this iterator, stopping once the provided limit is reached.

Parameters

limit

number

The maximum number of values to yield.

Returns

IteratorObject<DbEntry<K, V>, undefined, unknown>

Inherited from

Iterator.take

drop()

drop(count): IteratorObject<DbEntry<K, V>, undefined, unknown>

Defined in: site/node_modules/typescript/lib/lib.es2025.iterator.d.ts:72

Creates an iterator whose values are the values from this iterator after skipping the provided count.

Parameters

count

number

The number of values to drop.

Returns

IteratorObject<DbEntry<K, V>, undefined, unknown>

Inherited from

Iterator.drop

flatMap()

flatMap<U>(callback): IteratorObject<U, undefined, unknown>

Defined in: site/node_modules/typescript/lib/lib.es2025.iterator.d.ts:78

Creates an iterator whose values are the result of applying the callback to the values from this iterator and then flattening the resulting iterators or iterables.

Type Parameters

U

U

Parameters

callback

(value, index) => Iterator<U, unknown, undefined> | Iterable<U, unknown, undefined>

A function that accepts up to two arguments to be used to transform values from the underlying iterator into new iterators or iterables to be flattened into the result.

Returns

IteratorObject<U, undefined, unknown>

Inherited from

Iterator.flatMap

reduce()

Call Signature

reduce(callbackfn): DbEntry

Defined in: site/node_modules/typescript/lib/lib.es2025.iterator.d.ts:85

Calls the specified callback function for all the elements in this iterator. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters

callbackfn

(previousValue, currentValue, currentIndex) => DbEntry

A function that accepts up to three arguments. The reduce method calls the callbackfn function one time for each element in the iterator.

Returns

DbEntry

Inherited from

Iterator.reduce

Call Signature

reduce(callbackfn, initialValue): DbEntry

Defined in: site/node_modules/typescript/lib/lib.es2025.iterator.d.ts:86

Parameters

callbackfn

(previousValue, currentValue, currentIndex) => DbEntry

initialValue

DbEntry

Returns

DbEntry

Inherited from

Iterator.reduce

Call Signature

reduce<U>(callbackfn, initialValue): U

Defined in: site/node_modules/typescript/lib/lib.es2025.iterator.d.ts:93

Type Parameters

U

U

Parameters

callbackfn

(previousValue, currentValue, currentIndex) => U

A function that accepts up to three arguments. The reduce method calls the callbackfn function one time for each element in the iterator.

initialValue

U

If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of a value from the iterator.

Returns

U

Inherited from

Iterator.reduce

toArray()

toArray(): DbEntry<K, V>[]

Defined in: site/node_modules/typescript/lib/lib.es2025.iterator.d.ts:98

Creates a new array from the values yielded by this iterator.

Returns

DbEntry<K, V>[]

Inherited from

Iterator.toArray

forEach()

forEach(callbackfn): void

Defined in: site/node_modules/typescript/lib/lib.es2025.iterator.d.ts:104

Performs the specified action for each element in the iterator.

Parameters

callbackfn

(value, index) => void

A function that accepts up to two arguments. forEach calls the callbackfn function one time for each element in the iterator.

Returns

void

Inherited from

Iterator.forEach

some()

some(predicate): boolean

Defined in: site/node_modules/typescript/lib/lib.es2025.iterator.d.ts:112

Determines whether the specified callback function returns true for any element of this iterator.

Parameters

predicate

(value, index) => unknown

A function that accepts up to two arguments. The some method calls the predicate function for each element in this iterator until the predicate returns a value true, or until the end of the iterator.

Returns

boolean

Inherited from

Iterator.some

every()

every(predicate): boolean

Defined in: site/node_modules/typescript/lib/lib.es2025.iterator.d.ts:120

Determines whether all the members of this iterator satisfy the specified test.

Parameters

predicate

(value, index) => unknown

A function that accepts up to two arguments. The every method calls the predicate function for each element in this iterator until the predicate returns false, or until the end of this iterator.

Returns

boolean

Inherited from

Iterator.every

find()

Call Signature

find<S>(predicate): S

Defined in: site/node_modules/typescript/lib/lib.es2025.iterator.d.ts:129

Returns the value of the first element in this iterator where predicate is true, and undefined otherwise.

Type Parameters

S

S extends DbEntry<K, V>

Parameters

predicate

(value, index) => value is S

find calls predicate once for each element of this iterator, in order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

Returns

S

Inherited from

Iterator.find

Call Signature

find(predicate): DbEntry<K, V>

Defined in: site/node_modules/typescript/lib/lib.es2025.iterator.d.ts:130

Parameters

predicate

(value, index) => unknown

Returns

DbEntry<K, V>

Inherited from

Iterator.find

from()

static from<T>(value): IteratorObject<T, undefined, unknown>

Defined in: site/node_modules/typescript/lib/lib.es2025.iterator.d.ts:142

Creates a native iterator from an iterator or iterable object. Returns its input if the input already inherits from the built-in Iterator class.

Type Parameters

T

T

Parameters

value

Iterator<T, unknown, undefined> | Iterable<T, unknown, undefined>

An iterator or iterable object to convert a native iterator.

Returns

IteratorObject<T, undefined, unknown>

Inherited from

Iterator.from

[dispose]()

[dispose](): void

Defined in: site/node_modules/typescript/lib/lib.esnext.disposable.d.ts:34

Returns

void

Inherited from

Iterator.[dispose]