Class Dictionary<K, V>

Dictionary

Dictionary

Type Parameters

K
V

Hierarchy

Map<K, V>
- Dictionary

Index

Constructors

Properties

[toStringTag] size [species]

Accessors

count Count items Items

Methods

[iterator] Add AddOrSetValue clear Clear Contains ContainsValue delete entries forEach get has keys Remove set TryAdd TryGetValue values

Constructors

constructor

new Dictionary<K, V>(entries?): Dictionary<K, V>
Type Parameters
- K
- V
Parameters
- Optionalentries: null | readonly (readonly [K, V])[]
Returns Dictionary<K, V>
Inherited from Map<K, V>.constructor
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:50
new Dictionary<K, V>(iterable?): Dictionary<K, V>
Type Parameters
- K
- V
Parameters
- Optionaliterable: null | Iterable<readonly [K, V], any, any>
Returns Dictionary<K, V>
Inherited from Map<K, V>.constructor
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:49
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:50

Properties

`Readonly`[toStringTag]

[toStringTag]: string

`Readonly`size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly`[species]

[species]: MapConstructor

Accessors

count

get count(): number
Gets the number of keys and values stored.

Returns number
- Defined in src/collections.ts:146

Count

get Count(): number
Gets the number of keys and values stored.

Returns number
- Defined in src/collections.ts:134

items

get items(): {
[key: string]: V;
}
Gets all items

Returns {
[key: string]: V;
}
- [key: string]: V
- Defined in src/collections.ts:193

Items

get Items(): {
[key: string]: V;
}
Gets the keys and values stored in the Dictionary

Returns {
[key: string]: V;
}
- [key: string]: V
- Defined in src/collections.ts:156

Methods

[iterator]

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

Returns MapIterator<[K, V]>
Inherited from Map.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:143

Add

Add(key, value): void
Sets the specified value for the given key.
Parameters
- key: K
- value: V
Returns void
- Defined in src/collections.ts:115

AddOrSetValue

AddOrSetValue(key, value): void
Sets the specified value for the given key.
Parameters
- key: K
- value: V
Returns void
- Defined in src/collections.ts:105

clear

clear(): void
Returns void
Inherited from Map.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:20

Clear

Clear(): void
Clears the dictionary of all data

Returns void
- Defined in src/collections.ts:122

Contains

Contains(key): boolean
Returns true if the dictionary has the specified key, false if not.
Parameters
- key: K
Returns boolean
- Defined in src/collections.ts:223

ContainsValue

ContainsValue(value): boolean
Returns true if the dictionary contains the given value.
Parameters
- value: V
Returns boolean
- Defined in src/collections.ts:234

delete

delete(key): boolean
Parameters
- key: K
Returns boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Inherited from Map.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:24

entries

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

Returns MapIterator<[K, V]>
Inherited from Map.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:148

forEach

forEach(callbackfn, thisArg?): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: ((value: V, key: K, map: Map<K, V>) => void)
  - - (value, key, map): void
    - Parameters
      value: V
      key: K
      map: Map<K, V>
      Returns void
- OptionalthisArg: any
Returns void
Inherited from Map.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:28

get

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.
Parameters
- key: K
Returns undefined | 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

keys

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

Returns MapIterator<K>
Inherited from Map.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:153

Remove

Remove(key): void
Removes the given key and its value.
Parameters
- key: K
Returns void
- Defined in src/collections.ts:260

set

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.
Parameters
- key: K
- value: V
Returns this
Inherited from Map.set
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:41

TryAdd

TryAdd(key, value): boolean
Adds the given key and value
Parameters
- key: K
- value: V
Returns boolean
- Defined in src/collections.ts:250

TryGetValue

TryGetValue(key): {
found: boolean;
value: undefined | V;
}
Returns a boolean, which, if true, means value has valid information.
Parameters
- key: K
Returns {
found: boolean;
value: undefined | V;
}
- found: boolean
- value: undefined | V
- Defined in src/collections.ts:207

values

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

Returns MapIterator<V>
Inherited from Map.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:158