Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Dictionary<TKey, TValue>

Type parameters

  • TKey

  • TValue

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private keyPicker

keyPicker: StringKeyPicker<TKey>

Private keys

keys: string[]

Private keysToObjs

keysToObjs: IndexerWithStringKey<TKey>

Private objects

objects: IndexerWithStringKey<TValue>

Accessors

Count

  • get Count(): number

  • get number of objects in the dictionary

    Returns number

Items

  • get all items in key,value pair array

    Returns KeyValuePair<TKey, TValue>[]

Keys

  • get Keys(): TKey[]

  • get all keys

    Returns TKey[]

Values

  • get Values(): TValue[]

  • get all values

    Returns TValue[]

length

  • get length(): number

  • get number of objects in dictionary

    Returns number

Methods

Add

  • Add(key: TKey, value: TValue): void

  • add value or update the value for key

    Parameters

    • key: TKey
    • value: TValue

    Returns void

addUpdate

  • addUpdate(key: TKey, value: TValue): void

  • add value or update the value for key

    Parameters

    • key: TKey
    • value: TValue

    Returns void

clear

  • clear(): void

  • clear dictionary

    Returns void

containsKey

  • containsKey(key: string): boolean
  • containsKey(key: TKey): boolean

  • check if key exist

    Parameters

    • key: string

    Returns boolean

  • Parameters

    • key: TKey

    Returns boolean

get

  • get(key: string): TValue
  • get(key: TKey): TValue

  • get value for key

    Parameters

    • key: string

    Returns TValue

  • Parameters

    • key: TKey

    Returns TValue

getStringKeys

  • getStringKeys(): string[]

  • get string values of all keys

    Returns string[]

remove

  • remove(key: string): boolean
  • remove(key: TKey): boolean

  • remove key and value for key

    Parameters

    • key: string

    Returns boolean

  • Parameters

    • key: TKey

    Returns boolean

set

  • set(key: TKey, value: TValue): void

  • Set value for key

    Parameters

    • key: TKey
    • value: TValue

    Returns void

setEntry

  • setEntry(oldKey: string, newKey: TKey): void
  • setEntry(oldKey: TKey, newKey: TKey): void

  • sets the new entry with old value or optionally new value, use isnull parameter to make sure you are setting a null value instead of old value

    Parameters

    • oldKey: string
    • newKey: TKey

    Returns void

  • Parameters

    • oldKey: TKey
    • newKey: TKey

    Returns void

tryGetValue

  • tryGetValue(key: string, outValue: IOutParam<TValue>): boolean
  • tryGetValue(key: TKey, outValue: IOutParam<TValue>): boolean

  • try get value for key or return exception in IOutParam.exception

    Parameters

    Returns boolean

  • Parameters

    Returns boolean

Generated using TypeDoc