ISortedMap
Defined in: packages/data/src/map/isorted-map.ts:18
A map whose iteration order is the comparator’s, queried and iterated by key.
floor/ceiling/range/min/max are inherited from
IOrderedRange, returning whole entries — matching Java’s
floorEntry/ceilingEntry/subMap. firstKey/lastKey/floorKey/
ceilingKey are thin, key-only conveniences on top, for the common case
where the caller wants just the key.
Extends
Section titled “Extends”IMap<K,V>.IOrderedRange<SortedMapEntry<K,V>,K>
Type Parameters
Section titled “Type Parameters”K
V extends DefinedValue
Properties
Section titled “Properties”comparator
Section titled “comparator”
readonlycomparator:Comparator<K>
Defined in: packages/data/src/ordered-range/iordered-range.ts:23
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”[iterator]():
Iterator<readonly [K,V],any,any>
Defined in: node_modules/.store/typescript-npm-6.0.3-585eecd158/package/lib/lib.es2015.iterable.d.ts:47
Returns
Section titled “Returns”Iterator<readonly [K, V], any, any>
Inherited from
Section titled “Inherited from”ceiling()
Section titled “ceiling()”ceiling(
query):SortedMapEntry<K,V> |undefined
Defined in: packages/data/src/ordered-range/iordered-range.ts:27
Parameters
Section titled “Parameters”K
Returns
Section titled “Returns”SortedMapEntry<K, V> | undefined
Inherited from
Section titled “Inherited from”ceilingKey()
Section titled “ceilingKey()”ceilingKey(
key):K|undefined
Defined in: packages/data/src/map/isorted-map.ts:27
Sugar over ceiling(key)?.key.
Parameters
Section titled “Parameters”K
Returns
Section titled “Returns”K | undefined
clear()
Section titled “clear()”clear():
void
Defined in: packages/data/src/collection/icollection.ts:23
Removes all elements from the collection.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”count()
Section titled “count()”count():
number
Defined in: packages/data/src/collection/icollection.ts:20
The number of elements in the collection.
A method, not a getter: its async counterpart needs a round trip to the backing store, and a member must have the same shape in both.
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”delete()
Section titled “delete()”delete(
key):boolean
Defined in: packages/data/src/map/imap.ts:19
Parameters
Section titled “Parameters”K
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”entries()
Section titled “entries()”entries():
IterableIterator<readonly [K,V]>
Defined in: packages/data/src/map/imap.ts:22
Returns
Section titled “Returns”IterableIterator<readonly [K, V]>
Inherited from
Section titled “Inherited from”firstKey()
Section titled “firstKey()”firstKey():
K|undefined
Defined in: packages/data/src/map/isorted-map.ts:21
Sugar over min()?.key.
Returns
Section titled “Returns”K | undefined
floor()
Section titled “floor()”floor(
query):SortedMapEntry<K,V> |undefined
Defined in: packages/data/src/ordered-range/iordered-range.ts:26
Parameters
Section titled “Parameters”K
Returns
Section titled “Returns”SortedMapEntry<K, V> | undefined
Inherited from
Section titled “Inherited from”floorKey()
Section titled “floorKey()”floorKey(
key):K|undefined
Defined in: packages/data/src/map/isorted-map.ts:25
Sugar over floor(key)?.key.
Parameters
Section titled “Parameters”K
Returns
Section titled “Returns”K | undefined
get(
key):V|undefined
Defined in: packages/data/src/map/imap.ts:16
Parameters
Section titled “Parameters”K
Returns
Section titled “Returns”V | undefined
Inherited from
Section titled “Inherited from”has(
key):boolean
Defined in: packages/data/src/map/imap.ts:18
Parameters
Section titled “Parameters”K
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”keys()
Section titled “keys()”keys():
IterableIterator<K>
Defined in: packages/data/src/map/imap.ts:20
Returns
Section titled “Returns”IterableIterator<K>
Inherited from
Section titled “Inherited from”lastKey()
Section titled “lastKey()”lastKey():
K|undefined
Defined in: packages/data/src/map/isorted-map.ts:23
Sugar over max()?.key.
Returns
Section titled “Returns”K | undefined
max():
SortedMapEntry<K,V> |undefined
Defined in: packages/data/src/ordered-range/iordered-range.ts:25
Returns
Section titled “Returns”SortedMapEntry<K, V> | undefined
Inherited from
Section titled “Inherited from”min():
SortedMapEntry<K,V> |undefined
Defined in: packages/data/src/ordered-range/iordered-range.ts:24
Returns
Section titled “Returns”SortedMapEntry<K, V> | undefined
Inherited from
Section titled “Inherited from”range()
Section titled “range()”range(
from?,to?):IterableIterator<SortedMapEntry<K,V>>
Defined in: packages/data/src/ordered-range/iordered-range.ts:28
Parameters
Section titled “Parameters”K
K
Returns
Section titled “Returns”IterableIterator<SortedMapEntry<K, V>>
Inherited from
Section titled “Inherited from”set(
key,value):void
Defined in: packages/data/src/map/imap.ts:17
Parameters
Section titled “Parameters”K
V
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”values()
Section titled “values()”values():
IterableIterator<V>
Defined in: packages/data/src/map/imap.ts:21
Returns
Section titled “Returns”IterableIterator<V>