Interface IDictionary<TKey, TValue>

Type parameters

TKey
TValue

Hierarchy

ICollection<IKeyValuePair<TKey, TValue>>
- IDictionary
  - IStringKeyDictionary
  - IOrderedDictionary

Implemented by

Index

Properties

Methods

Properties

count

count: number

Optional isEndless

isEndless: boolean

Provides a way of flagging endless enumerations that may cause issues.

isReadOnly

isReadOnly: boolean

keys

keys: TKey[]

values

values: TValue[]

Methods

add

add(entry: IKeyValuePair<TKey, TValue>): void

Inherited from ICollection.add
- Defined in source/System/Collections/ICollection.d.ts:12
Parameters
- entry: IKeyValuePair<TKey, TValue>
Returns void

addByKeyValue

addByKeyValue(key: TKey, value: TValue): boolean

- Defined in source/System/Collections/Dictionaries/IDictionary.d.ts:28
Parameters
- key: TKey
- value: TValue
Returns boolean

clear

clear(): number

Inherited from ICollection.clear
- Defined in source/System/Collections/ICollection.d.ts:14
Returns number

contains

contains(entry: IKeyValuePair<TKey, TValue>): boolean

Inherited from IReadOnlyCollection.contains
- Defined in source/System/Collections/IReadOnlyCollection.d.ts:16
Parameters
- entry: IKeyValuePair<TKey, TValue>
Returns boolean

containsKey

containsKey(key: TKey): boolean

- Defined in source/System/Collections/Dictionaries/IDictionary.d.ts:31
Parameters
- key: TKey
Returns boolean

containsValue

containsValue(value: TValue): boolean

- Defined in source/System/Collections/Dictionaries/IDictionary.d.ts:32
Parameters
- value: TValue
Returns boolean

copyTo

copyTo<TTarget>(target: TTarget, index?: number): TTarget

Inherited from IReadOnlyCollection.copyTo
- Defined in source/System/Collections/IReadOnlyCollection.d.ts:17
Type parameters
- TTarget: IArray
Parameters
- target: TTarget
- Optional index: number
Returns TTarget

getEnumerator

getEnumerator(): IEnumerator<IKeyValuePair<TKey, TValue>>

Inherited from IEnumerable.getEnumerator
- Defined in source/System/Collections/Enumeration/IEnumerable.d.ts:10
Returns IEnumerator<IKeyValuePair<TKey, TValue>>

getValue

getValue(key: TKey): TValue

- Defined in source/System/Collections/Dictionaries/IDictionary.d.ts:29
Parameters
- key: TKey
Returns TValue

importEntries

importEntries(entries: IEnumerableOrArray): number

Inherited from ICollection.importEntries
- Defined in source/System/Collections/ICollection.d.ts:16
Parameters
- entries: IEnumerableOrArray
Returns number

remove

remove(entry: IKeyValuePair<TKey, TValue>, max?: number): number

Inherited from ICollection.remove
- Defined in source/System/Collections/ICollection.d.ts:13
Parameters
- entry: IKeyValuePair<TKey, TValue>
- Optional max: number
Returns number

removeByKey

removeByKey(key: TKey): boolean

- Defined in source/System/Collections/Dictionaries/IDictionary.d.ts:33
Parameters
- key: TKey
Returns boolean

removeByValue

removeByValue(value: TValue): number

- Defined in source/System/Collections/Dictionaries/IDictionary.d.ts:34
Parameters
- value: TValue
Returns number

setValue

setValue(key: TKey, value: TValue): boolean

- Defined in source/System/Collections/Dictionaries/IDictionary.d.ts:30
Parameters
- key: TKey
- value: TValue
Returns boolean

toArray

toArray(): IKeyValuePair<TKey, TValue>[]

Inherited from ICollection.toArray

Overwrites IReadOnlyCollection.toArray
- Defined in source/System/Collections/ICollection.d.ts:17
Returns IKeyValuePair<TKey, TValue>[]

Generated using TypeDoc