IOrderedRange
Defined in: packages/data/src/ordered-range/iordered-range.ts:22
Ordering operations shared by anything whose iteration order follows a comparator.
T is what is stored and returned; Q is what a query is made with — Q = T for a set, Q = K (the key) for a map over T = SortedMapEntry<K, V>.
This is the resolution to “should ISortedSet/ISortedMap be one
parameterised interface”: not by one extending the other, but by both
composing this shared, query-type-aware mixin.
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”T
The type returned by min/max/floor/ceiling/range.
Q = T
The type a query is made with.
Properties
Section titled “Properties”comparator
Section titled “comparator”
readonlycomparator:Comparator<Q>
Defined in: packages/data/src/ordered-range/iordered-range.ts:23
Methods
Section titled “Methods”ceiling()
Section titled “ceiling()”ceiling(
query):T|undefined
Defined in: packages/data/src/ordered-range/iordered-range.ts:27
Parameters
Section titled “Parameters”Q
Returns
Section titled “Returns”T | undefined
floor()
Section titled “floor()”floor(
query):T|undefined
Defined in: packages/data/src/ordered-range/iordered-range.ts:26
Parameters
Section titled “Parameters”Q
Returns
Section titled “Returns”T | undefined
max():
T|undefined
Defined in: packages/data/src/ordered-range/iordered-range.ts:25
Returns
Section titled “Returns”T | undefined
min():
T|undefined
Defined in: packages/data/src/ordered-range/iordered-range.ts:24
Returns
Section titled “Returns”T | undefined
range()
Section titled “range()”range(
from?,to?):IterableIterator<T>
Defined in: packages/data/src/ordered-range/iordered-range.ts:28
Parameters
Section titled “Parameters”Q
Q
Returns
Section titled “Returns”IterableIterator<T>