Class Dictionary<K, V>

Type parameters

  • K

  • V

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • Default value options: object = { ignoreCase: false, checkType: false }
      • Optional checkType?: boolean
      • Optional ignoreCase?: boolean

    Returns Dictionary

Properties

entries

entries: Map<string | K, object> = new Map<K | string, { key: K, value: V }>()

Accessors

count

  • get count(): number

  • Gets the number of key/value pairs contained in the Hashtable.

    Returns number

keys

pairs

  • get pairs(): Iterable<object>

  • Returns Iterable<object>

values

Methods

[Symbol.iterator]

  • [Symbol.iterator](): Iterator<object>

add

  • add(key: K, value: V): void

  • Adds an element with the specified key and value into the Hashtable.

    Parameters

    • key: K
    • value: V

    Returns void

clear

  • clear(): void

  • Removes all elements from the Hashtable.

    Returns void

clone

contains

  • contains(key: K): boolean

  • Determines whether the Hashtable contains a specific key.

    Parameters

    • key: K

    Returns boolean

containsKey

  • containsKey(key: K): boolean

  • Determines whether the Hashtable contains a specific key.

    Parameters

    • key: K

    Returns boolean

containsValue

  • containsValue(value: V): boolean

  • Determines whether the Hashtable contains a specific value.

    Parameters

    • value: V

    Returns boolean

copyTo

  • copyTo(array: V[], arrayIndex: number): void

  • Copies the Hashtable elements to a one-dimensional Array instance at the specified index.

    Parameters

    • array: V[]
    • arrayIndex: number

    Returns void

get

  • get(key: K): V

Protected getActualKey

  • getActualKey(key: K): string | K

getByIndex

  • getByIndex(index: number): V

Protected getRawValueByKey

  • getRawValueByKey(key: K): object

indexOfKey

  • indexOfKey(key: K): number

remove

  • remove(key: K): void

  • Removes the element with the specified key from the Hashtable.

    Parameters

    • key: K

    Returns void

set

  • set(key: K, value: V): void

  • Parameters

    • key: K
    • value: V

    Returns void

tryGetValue

  • tryGetValue(key: K, out: object): boolean

  • Parameters

    • key: K
    • out: object
      • ref: V

    Returns boolean

Generated using TypeDoc