Class SortedMap<K, V>

Type Parameters

Hierarchy

Map<K, V>
- SortedMap

Implements

IterableIterator<[K, V]>

Index

Constructors

constructor

new SortedMap<K, V>(): SortedMap<K, V>
Type Parameters
- K
- V
Returns SortedMap<K, V>
Overrides Map<K, V>.constructor
- Defined in src/SortedMap.ts:9
new SortedMap<K, V>(entries?, comparator?): SortedMap<K, V>
Type Parameters
- K
- V
Parameters
- Optional entries: Iterable<readonly [K, V]>
- Optional comparator: ((a, b, c?, d?) => number)
  - - (a, b, c?, d?): number
    - Parameters
      a: K
      b: K
      Optional c: V
      Optional d: V
      Returns number
Returns SortedMap<K, V>
Overrides Map<K, V>.constructor
- Defined in src/SortedMap.ts:10

Properties

`Readonly` [toStringTag]

[toStringTag]: string

`Readonly` size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly` [species]

[species]: MapConstructor

Methods

[iterator]

[iterator](): IterableIterator<[K, V]>
Returns an iterable of entries in the map.

Returns IterableIterator<[K, V]>
an iterable of entries in the map.
Implementation of IterableIterator.[iterator]
Overrides Map.[iterator]
- Defined in src/SortedMap.ts:155

clear

clear(): void
The clear() method removes all elements from a Map object.

Returns void
Overrides Map.clear
- Defined in src/SortedMap.ts:94

delete

delete(key): boolean
The delete() method removes the specified element from a Map object by key.
Parameters
- key: K
  The key of the element to remove from the Map object.
Returns boolean
true if an element in the Map object existed and has been removed, or false if the element does not exist.
Overrides Map.delete
- Defined in src/SortedMap.ts:104

entries

entries(): IterableIterator<[K, V]>
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[K, V]>
an iterable of key, value pairs for every entry in the map.
Overrides Map.entries
- Defined in src/SortedMap.ts:163

firstKey

firstKey(): K
Returns the first (lowest) key currently in this map.

Returns K
the first (lowest) key currently in this map
- Defined in src/SortedMap.ts:31

forEach

forEach(callbackFn, thisArg?): void
The forEach() method executes a provided function once per each key/value pair in the Map object, in insertion order.
Parameters
- callbackFn: ((value, key, map) => void)
  Function to execute for each entry in the map.
  - - (value, key, map): void
    - Parameters
      value: V
      key: K
      map: SortedMap<K, V>
      Returns void
- Optional thisArg: any
  Value to use as this when executing callback.
Returns void
Overrides Map.forEach
- Defined in src/SortedMap.ts:224

get

get(key): V
Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.
Parameters
- key: K
Returns V
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Inherited from Map.get
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:33

has

has(key): boolean
Parameters
- key: K
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Inherited from Map.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:37

headMap

headMap(toKey): SortedMap<K, V>
Returns a view of the portion of this map whose keys are strictly less than toKey.
Parameters
- toKey: K
  high endpoint (exclusive) of the keys in the returned map
Returns SortedMap<K, V>
a view of the portion of this map whose keys are strictly less than toKey
- Defined in src/SortedMap.ts:81

keys

keys(): IterableIterator<K>
Returns an iterable of keys in the map

Returns IterableIterator<K>
an iterable of keys in the map
Overrides Map.keys
- Defined in src/SortedMap.ts:173

lastKey

lastKey(): K
Returns the last (highest) key currently in this map.

Returns K
the last (highest) key currently in this map
- Defined in src/SortedMap.ts:43

next(value?): IteratorResult<[K, V], any>
Parameters
- Optional value: any
Returns IteratorResult<[K, V], any>
Implementation of IterableIterator.next
- Defined in src/SortedMap.ts:230

return

return(value?): IteratorResult<[K, V], any>
Parameters
- Optional value: any
Returns IteratorResult<[K, V], any>
Implementation of IterableIterator.return
- Defined in src/SortedMap.ts:234

set

set(key, value): SortedMap<K, V>
The set() method adds or updates an element with a specified key and a value to a Map object.
Parameters
- key: K
  The key of the element to add to the Map object.
- value: V
  The value of the element to add to the Map object.
Returns SortedMap<K, V>
The Map object.
Overrides Map.set
- Defined in src/SortedMap.ts:118

setIfAbsent

setIfAbsent(key, value): V
If the specified key is not already associated with a value associates it with the given value and returns that value, else returns the current value.
Parameters
- key: K
  key with which the specified value is to be associated
- value: V
  value to be associated with the specified key
Returns V
the previous value associated with the specified key, or the specified value if there was no mapping for the key.
- Defined in src/SortedMap.ts:142

subMap

subMap(fromKey, toKey): SortedMap<K, V>
Returns a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive.
Parameters
- fromKey: K
  low endpoint (inclusive) of the keys in the returned map
- toKey: K
  high endpoint (exclusive) of the keys in the returned map
Returns SortedMap<K, V>
a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive
- Defined in src/SortedMap.ts:72

tailMap

tailMap(fromKey): SortedMap<K, V>
Returns a view of the portion of this map whose keys are greater than or equal to fromKey.
Parameters
- fromKey: K
  low endpoint (inclusive) of the keys in the returned map
Returns SortedMap<K, V>
a view of the portion of this map whose keys are greater than or equal to fromKey
- Defined in src/SortedMap.ts:56

throw

throw(e?): IteratorResult<[K, V], any>
Parameters
- Optional e: any
Returns IteratorResult<[K, V], any>
Implementation of IterableIterator.throw
- Defined in src/SortedMap.ts:238

values

values(): IterableIterator<V>
Returns an iterable of values in the map.

Returns IterableIterator<V>
an iterable of values in the map.
Overrides Map.values
- Defined in src/SortedMap.ts:213

Class SortedMap<K, V>

Type Parameters

K

V

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

K

V

Returns SortedMap<K, V>

Type Parameters

K

V

Parameters

Optional entries: Iterable<readonly [K, V]>

Optional comparator: ((a, b, c?, d?) => number)

Parameters

a: K

b: K

Optional c: V

Optional d: V

Returns number

Returns SortedMap<K, V>

Properties

Readonly [toStringTag]

Readonly size

Returns

Static Readonly [species]

Methods

[iterator]

Returns IterableIterator<[K, V]>

clear

Returns void

delete

Parameters

key: K

Returns boolean

entries

Returns IterableIterator<[K, V]>

firstKey

Returns K

forEach

Parameters

callbackFn: ((value, key, map) => void)

Parameters

value: V

key: K

map: SortedMap<K, V>

Returns void

Optional thisArg: any

Returns void

get

Parameters

key: K

Returns V

has

Parameters

key: K

Returns boolean

headMap

Parameters

toKey: K

Returns SortedMap<K, V>

keys

Returns IterableIterator<K>

lastKey

Returns K

next

Parameters

Optional value: any

Returns IteratorResult<[K, V], any>

return

Parameters

Optional value: any

`Optional` entries: Iterable<readonly [K, V]>

`Optional` comparator: ((a, b, c?, d?) => number)

`Optional` c: V

`Optional` d: V

`Readonly` [toStringTag]

`Readonly` size

`Static` `Readonly` [species]

`Optional` thisArg: any

`Optional` value: any

`Optional` value: any

`Optional` e: any