About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class KeyValuePair<TKey, TValue>

Defines a key/value pair that can be set or retrieved.

Type Parameters

TKey
TValue

Hierarchy (View Summary)

System.Object
- KeyValuePair

Index

Constructors

Accessors

Methods

Cast Equals GetHashCode ToString TryCast Equals

Constructors

constructor

new KeyValuePair<TKey, TValue>(
    typeTKey: TypeRefParam<TKey>,
    typeTValue: TypeRefParam<TValue>,
    key: TKey | JsType<TKey>,
    value: TValue | JsType<TValue>,
): KeyValuePair<TKey, TValue>
Initializes a new instance of the System.Collections.Generic.KeyValuePair structure with the specified key and value.
Type Parameters
- TKey
- TValue
Parameters
- typeTKey: TypeRefParam<TKey>
  Generic type argument
- typeTValue: TypeRefParam<TValue>
  Generic type argument
- key: TKey | JsType<TKey>
  The object defined in each key/value pair.
- value: TValue | JsType<TValue>
  The definition associated with key.
Returns KeyValuePair<TKey, TValue>
Overrides Object.constructor

Accessors

Key

get Key(): JsType<TKey>
Gets the key in the key/value pair.

Returns JsType<TKey>
A TKey that is the key of the System.Collections.Generic.KeyValuePair.

Value

get Value(): JsType<TValue>
Gets the value in the key/value pair.

Returns JsType<TValue>
A TValue that is the value of the System.Collections.Generic.KeyValuePair.

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): 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

Equals

Equals(obj: any): 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

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: T2, type: TypeRef<T1>): 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

`Static`Equals

Equals(objA: any, objB: any): 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