Class Dictionary<TKey, TValue>

Represents a collection of keys and values.

Type Parameters

TKey
TValue

Hierarchy (view full)

System.Object
- Dictionary

Index

Constructors

constructor

new Dictionary<TKey, TValue>(typeTKey, typeTValue): Dictionary<TKey, TValue>
Initializes a new instance of the System.Collections.Generic.Dictionary class that is empty, has the default initial capacity, and uses the default equality comparer for the key type.
Type Parameters
- TKey
- TValue
Parameters
- typeTKey: TypeRefParam<TKey>
  Generic type argument
- typeTValue: TypeRefParam<TValue>
  Generic type argument
Returns Dictionary<TKey, TValue>
Overrides Object.constructor

Properties

`Readonly`Item

Item: PropertyGet<TKey | JsType<TKey>, JsType<TValue>> & PropertySet<TKey | JsType<TKey>, TValue | JsType<TValue>>

Gets or sets the value associated with the specified key.

Param: key

The key of the value to get or set.

Returns

The value associated with the specified key. If the specified key is not found, a get operation throws a System.Collections.Generic.KeyNotFoundException, and a set operation creates a new element with the specified key.

Accessors

Count

get Count(): number
Gets the number of key/value pairs contained in the System.Collections.Generic.Dictionary.

Returns number
The number of key/value pairs contained in the System.Collections.Generic.Dictionary.

Keys

get Keys(): System.Collections.Generic.Dictionary.KeyCollection<TKey, TValue>
Gets a collection containing the keys in the System.Collections.Generic.Dictionary.

Returns System.Collections.Generic.Dictionary.KeyCollection<TKey, TValue>
A System.Collections.Generic.Dictionary.KeyCollection containing the keys in the System.Collections.Generic.Dictionary.

Values

get Values(): System.Collections.Generic.Dictionary.ValueCollection<TKey, TValue>
Gets a collection containing the values in the System.Collections.Generic.Dictionary.

Returns System.Collections.Generic.Dictionary.ValueCollection<TKey, TValue>
A System.Collections.Generic.Dictionary.ValueCollection containing the values in the System.Collections.Generic.Dictionary.

Methods

Add

Add(key, value): void
Adds the specified key and value to the dictionary.
Parameters
- key: TKey | JsType<TKey>
  The key of the element to add.
- value: TValue | JsType<TValue>
  The value of the element to add. The value can be null for reference types.
Returns void

Cast

Cast<T1, T2>(this, type): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from Object.Cast

Clear

Clear(): void
Removes all keys and values from the System.Collections.Generic.Dictionary.

Returns void

ContainsKey

ContainsKey(key): boolean
Determines whether the System.Collections.Generic.Dictionary contains the specified key.
Parameters
- key: TKey | JsType<TKey>
  The key to locate in the System.Collections.Generic.Dictionary.
Returns boolean
true if the System.Collections.Generic.Dictionary contains an element with the specified key; otherwise, false.

Equals

Equals(obj): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from Object.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

Remove

Remove(key): boolean
Removes the value with the specified key from the System.Collections.Generic.Dictionary.
Parameters
- key: TKey | JsType<TKey>
  The key of the element to remove.
Returns boolean
true if the element is successfully found and removed; otherwise, false. This method returns false if key is not found in the System.Collections.Generic.Dictionary.

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from Object.ToString

TryCast

TryCast<T1, T2>(this, type): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from Object.TryCast

[iterator]

[iterator](): Iterator<KeyValuePair<TKey, TValue>, any, undefined>
Returns Iterator<KeyValuePair<TKey, TValue>, any, undefined>

`Static`Equals

Equals(objA, objB): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from Object.Equals

Class Dictionary<TKey, TValue>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Dictionary<TKey, TValue>

Properties

ReadonlyItem

Param: key

Returns

Accessors

Count

Returns number

Keys

Returns System.Collections.Generic.Dictionary.KeyCollection<TKey, TValue>

Values

Returns System.Collections.Generic.Dictionary.ValueCollection<TKey, TValue>

Methods

Add

Parameters

Returns void

Cast

Type Parameters

Parameters

Returns T1

Clear

Returns void

ContainsKey

Parameters

Returns boolean

Equals

Parameters

Returns boolean

GetHashCode

Returns number

Remove

Parameters

Returns boolean

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

[iterator]

Returns Iterator<KeyValuePair<TKey, TValue>, any, undefined>

StaticEquals

Parameters

Returns boolean

Settings

On This Page

`Readonly`Item

`Static`Equals