IndexRangeIterator
Defined in: .work/repos/edinburgh/src/indexes.ts:56
Iterator for range queries on indexes. Handles common iteration logic for both primary and unique indexes. Extends built-in Iterator to provide map/filter/reduce/toArray/etc.
Extends
Section titled “Extends”Iterator<ITEM>
Type Parameters
Section titled “Type Parameters”ITEM
Properties
Section titled “Properties”[toStringTag]
Section titled “[toStringTag]”
readonly[toStringTag]:string
Defined in: site/node_modules/typescript/lib/lib.es2025.iterator.d.ts:132
Inherited from
Section titled “Inherited from”Iterator.[toStringTag]
Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”[iterator]():
this
Defined in: .work/repos/edinburgh/src/indexes.ts:65
Returns
Section titled “Returns”this
Overrides
Section titled “Overrides”Iterator.[iterator]
next()
Section titled “next()”next():
IteratorResult<ITEM>
Defined in: .work/repos/edinburgh/src/indexes.ts:67
Returns
Section titled “Returns”IteratorResult<ITEM>
Overrides
Section titled “Overrides”Iterator.next
count()
Section titled “count()”count():
number
Defined in: .work/repos/edinburgh/src/indexes.ts:83
Returns
Section titled “Returns”number
fetch()
Section titled “fetch()”fetch():
ITEM
Defined in: .work/repos/edinburgh/src/indexes.ts:89
Returns
Section titled “Returns”ITEM
return()?
Section titled “return()?”
optionalreturn(value?):IteratorResult<ITEM,undefined>
Defined in: site/node_modules/typescript/lib/lib.es2015.iterable.d.ts:42
Parameters
Section titled “Parameters”value?
Section titled “value?”undefined
Returns
Section titled “Returns”IteratorResult<ITEM, undefined>
Inherited from
Section titled “Inherited from”Iterator.return
throw()?
Section titled “throw()?”
optionalthrow(e?):IteratorResult<ITEM,undefined>
Defined in: site/node_modules/typescript/lib/lib.es2015.iterable.d.ts:43
Parameters
Section titled “Parameters”any
Returns
Section titled “Returns”IteratorResult<ITEM, undefined>
Inherited from
Section titled “Inherited from”Iterator.throw
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
Section titled “Type Parameters”U
Parameters
Section titled “Parameters”callbackfn
Section titled “callbackfn”(value, index) => U
A function that accepts up to two arguments to be used to transform values from the underlying iterator.
Returns
Section titled “Returns”IteratorObject<U, undefined, unknown>
Inherited from
Section titled “Inherited from”Iterator.map
filter()
Section titled “filter()”Call Signature
Section titled “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
Section titled “Type Parameters”S
Parameters
Section titled “Parameters”predicate
Section titled “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
Section titled “Returns”IteratorObject<S, undefined, unknown>
Inherited from
Section titled “Inherited from”Iterator.filter
Call Signature
Section titled “Call Signature”filter(
predicate):IteratorObject<ITEM,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
Section titled “Parameters”predicate
Section titled “predicate”(value, index) => unknown
A function that accepts up to two arguments to be used to test values from the underlying iterator.
Returns
Section titled “Returns”IteratorObject<ITEM, undefined, unknown>
Inherited from
Section titled “Inherited from”Iterator.filter
take()
Section titled “take()”take(
limit):IteratorObject<ITEM,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
Section titled “Parameters”number
The maximum number of values to yield.
Returns
Section titled “Returns”IteratorObject<ITEM, undefined, unknown>
Inherited from
Section titled “Inherited from”Iterator.take
drop()
Section titled “drop()”drop(
count):IteratorObject<ITEM,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
Section titled “Parameters”number
The number of values to drop.
Returns
Section titled “Returns”IteratorObject<ITEM, undefined, unknown>
Inherited from
Section titled “Inherited from”Iterator.drop
flatMap()
Section titled “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
Section titled “Type Parameters”U
Parameters
Section titled “Parameters”callback
Section titled “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
Section titled “Returns”IteratorObject<U, undefined, unknown>
Inherited from
Section titled “Inherited from”Iterator.flatMap
reduce()
Section titled “reduce()”Call Signature
Section titled “Call Signature”reduce(
callbackfn):ITEM
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
Section titled “Parameters”callbackfn
Section titled “callbackfn”(previousValue, currentValue, currentIndex) => ITEM
A function that accepts up to three arguments. The reduce method calls the callbackfn function one time for each element in the iterator.
Returns
Section titled “Returns”ITEM
Inherited from
Section titled “Inherited from”Iterator.reduce
Call Signature
Section titled “Call Signature”reduce(
callbackfn,initialValue):ITEM
Defined in: site/node_modules/typescript/lib/lib.es2025.iterator.d.ts:86
Parameters
Section titled “Parameters”callbackfn
Section titled “callbackfn”(previousValue, currentValue, currentIndex) => ITEM
initialValue
Section titled “initialValue”ITEM
Returns
Section titled “Returns”ITEM
Inherited from
Section titled “Inherited from”Iterator.reduce
Call Signature
Section titled “Call Signature”reduce<
U>(callbackfn,initialValue):U
Defined in: site/node_modules/typescript/lib/lib.es2025.iterator.d.ts:93
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.
Type Parameters
Section titled “Type Parameters”U
Parameters
Section titled “Parameters”callbackfn
Section titled “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
Section titled “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
Section titled “Returns”U
Inherited from
Section titled “Inherited from”Iterator.reduce
toArray()
Section titled “toArray()”toArray():
ITEM[]
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
Section titled “Returns”ITEM[]
Inherited from
Section titled “Inherited from”Iterator.toArray
forEach()
Section titled “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
Section titled “Parameters”callbackfn
Section titled “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
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Iterator.forEach
some()
Section titled “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
Section titled “Parameters”predicate
Section titled “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
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Iterator.some
every()
Section titled “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
Section titled “Parameters”predicate
Section titled “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
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Iterator.every
find()
Section titled “find()”Call Signature
Section titled “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
Section titled “Type Parameters”S
Parameters
Section titled “Parameters”predicate
Section titled “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
Section titled “Returns”S
Inherited from
Section titled “Inherited from”Iterator.find
Call Signature
Section titled “Call Signature”find(
predicate):ITEM
Defined in: site/node_modules/typescript/lib/lib.es2025.iterator.d.ts:130
Parameters
Section titled “Parameters”predicate
Section titled “predicate”(value, index) => unknown
Returns
Section titled “Returns”ITEM
Inherited from
Section titled “Inherited from”Iterator.find
[dispose]()
Section titled “[dispose]()”[dispose]():
void
Defined in: site/node_modules/typescript/lib/lib.esnext.disposable.d.ts:34
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Iterator.[dispose]