Interface IDictionary

Represents a nongeneric collection of key/value pairs.

interface IDictionary {
    Item: PropertyGet<any, unknown> & PropertySet<any, any>;
    get Count(): number;
    get IsFixedSize(): boolean;
    get IsReadOnly(): boolean;
    get Keys(): System.Collections.ICollection;
    get Values(): System.Collections.ICollection;
    Add(key: any, value: any): void;
    Add(key: any, value: any): void;
    Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1;
    Clear(): void;
    Contains(key: any): boolean;
    Contains(key: any): boolean;
    Remove(key: any): void;
    Remove(key: any): void;
    TryCast<T1, T2>(this: T2, type: TypeRef<T1>): null | T1;
    [iterator](): Iterator<unknown, any, undefined>;
}

Hierarchy (view full)

IInterfaceBase
System.Collections.ICollection
System.Collections.IEnumerable
- IDictionary

Index

Properties

`Readonly`Item

Item: PropertyGet<any, unknown> & PropertySet<any, any>

Gets or sets the element with the specified key.

Param: key

The key of the element to get or set.

Returns

The element with the specified key, or null if the key does not exist.

Accessors

Count

get Count(): number
Gets the number of elements contained in the System.Collections.ICollection.

Returns number
The number of elements contained in the System.Collections.ICollection.

Inherited from ICollection.Count

IsFixedSize

get IsFixedSize(): boolean
Gets a value indicating whether the System.Collections.IDictionary object has a fixed size.

Returns boolean
true if the System.Collections.IDictionary object has a fixed size; otherwise, false.

IsReadOnly

get IsReadOnly(): boolean
Gets a value indicating whether the System.Collections.IDictionary object is read-only.

Returns boolean
true if the System.Collections.IDictionary object is read-only; otherwise, false.

Keys

get Keys(): System.Collections.ICollection
Gets an System.Collections.ICollection object containing the keys of the System.Collections.IDictionary object.

Returns System.Collections.ICollection
An System.Collections.ICollection object containing the keys of the System.Collections.IDictionary object.

Values

get Values(): System.Collections.ICollection
Gets an System.Collections.ICollection object containing the values in the System.Collections.IDictionary object.

Returns System.Collections.ICollection
An System.Collections.ICollection object containing the values in the System.Collections.IDictionary object.

Methods

Add

Add(key, value): void
Adds an element with the provided key and value to the System.Collections.IDictionary object.
Parameters
- key: any
  The System.Object to use as the key of the element to add.
- value: any
  The System.Object to use as the value of the element to add.
Returns void
Add(key, value): void
Adds an element with the provided key and value to the System.Collections.IDictionary object.
Parameters
- key: any
  The System.Object to use as the key of the element to add.
- value: any
  The System.Object to use as the value of the element to add.
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 IEnumerable.Cast

Clear

Clear(): void
Removes all elements from the System.Collections.IDictionary object.

Returns void

Contains

Contains(key): boolean
Determines whether the System.Collections.IDictionary object contains an element with the specified key.
Parameters
- key: any
  The key to locate in the System.Collections.IDictionary object.
Returns boolean
true if the System.Collections.IDictionary contains an element with the key; otherwise, false.
Contains(key): boolean
Determines whether the System.Collections.IDictionary object contains an element with the specified key.
Parameters
- key: any
  The key to locate in the System.Collections.IDictionary object.
Returns boolean
true if the System.Collections.IDictionary contains an element with the key; otherwise, false.

Remove

Remove(key): void
Removes the element with the specified key from the System.Collections.IDictionary object.
Parameters
- key: any
  The key of the element to remove.
Returns void
Remove(key): void
Removes the element with the specified key from the System.Collections.IDictionary object.
Parameters
- key: any
  The key of the element to remove.
Returns void

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 IEnumerable.TryCast

[iterator]

[iterator](): Iterator<unknown, any, undefined>
Returns Iterator<unknown, any, undefined>
Overrides IEnumerable.[iterator]

Interface IDictionary

Hierarchy (view full)

Index

Properties

Accessors

Methods

Properties

ReadonlyItem

Param: key

Returns

Accessors

Count

Returns number

IsFixedSize

Returns boolean

IsReadOnly

Returns boolean

Keys

Returns System.Collections.ICollection

Values

Returns System.Collections.ICollection

Methods

Add

Parameters

Returns void

Parameters

Returns void

Cast

Type Parameters

Parameters

Returns T1

Clear

Returns void

Contains

Parameters

Returns boolean

Parameters

Returns boolean

Remove

Parameters

Returns void

Parameters

Returns void

TryCast

Type Parameters

Parameters

Returns null | T1

[iterator]

Returns Iterator<unknown, any, undefined>

Settings

On This Page

`Readonly`Item