delphirtl • Docs
delphirtl / Dictionary
Dictionary
Dictionary
Map<K, V>• K
• V
new Dictionary<
K,V>(entries?):Dictionary<K,V>
• entries?: null | readonly readonly [K, V][]
Dictionary<K, V>
Map<K, V>.constructor
node_modules/typescript/lib/lib.es2015.collection.d.ts:50
new Dictionary<
K,V>(iterable?):Dictionary<K,V>
• iterable?: null | Iterable<readonly [K, V], any, any>
Dictionary<K, V>
Map<K, V>.constructor
node_modules/typescript/lib/lib.es2015.collection.d.ts:49
readonly[toStringTag]:string
Map.[toStringTag]
node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:137
readonlysize:number
the number of elements in the Map.
Map.size
node_modules/typescript/lib/lib.es2015.collection.d.ts:45
readonlystatic[species]:MapConstructor
Map.[species]
node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:319
get count():
number
Gets the number of keys and values stored.
number
get Count():
number
Gets the number of keys and values stored.
number
get items():
object
Gets all items
object
get Items():
object
Gets the keys and values stored in the Dictionary
object
[iterator]():
MapIterator<[K,V]>
Returns an iterable of entries in the map.
MapIterator<[K, V]>
Map.[iterator]
node_modules/typescript/lib/lib.es2015.iterable.d.ts:143
Add(
key,value):void
Sets the specified value for the given key.
• key: K
• value: V
void
AddOrSetValue(
key,value):void
Sets the specified value for the given key.
• key: K
• value: V
void
clear():
void
void
Map.clear
node_modules/typescript/lib/lib.es2015.collection.d.ts:20
Clear():
void
Clears the dictionary of all data
void
Contains(
key):boolean
Returns true if the dictionary has the specified key, false if not.
• key: K
boolean
ContainsValue(
value):boolean
Returns true if the dictionary contains the given value.
• value: V
boolean
delete(
key):boolean
• key: K
boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Map.delete
node_modules/typescript/lib/lib.es2015.collection.d.ts:24
entries():
MapIterator<[K,V]>
Returns an iterable of key, value pairs for every entry in the map.
MapIterator<[K, V]>
Map.entries
node_modules/typescript/lib/lib.es2015.iterable.d.ts:148
forEach(
callbackfn,thisArg?):void
Executes a provided function once per each key/value pair in the Map, in insertion order.
• callbackfn
• thisArg?: any
void
Map.forEach
node_modules/typescript/lib/lib.es2015.collection.d.ts:28
get(
key):undefined|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.
• key: K
undefined | V
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Map.get
node_modules/typescript/lib/lib.es2015.collection.d.ts:33
has(
key):boolean
• key: K
boolean
boolean indicating whether an element with the specified key exists or not.
Map.has
node_modules/typescript/lib/lib.es2015.collection.d.ts:37
keys():
MapIterator<K>
Returns an iterable of keys in the map
MapIterator<K>
Map.keys
node_modules/typescript/lib/lib.es2015.iterable.d.ts:153
Remove(
key):void
Removes the given key and its value.
• key: K
void
set(
key,value):this
Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.
• key: K
• value: V
this
Map.set
node_modules/typescript/lib/lib.es2015.collection.d.ts:41
TryAdd(
key,value):boolean
Adds the given key and value
• key: K
• value: V
boolean
TryGetValue(
key):object
Returns a boolean, which, if true, means value has valid information.
• key: K
object
found:
boolean
value:
undefined|V
values():
MapIterator<V>
Returns an iterable of values in the map
MapIterator<V>
Map.values
node_modules/typescript/lib/lib.es2015.iterable.d.ts:158