Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Dictionary<TKey, TValue>

Type parameters

  • TKey

  • TValue

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private _buckets

_buckets: IMap<LinkedNodeList<IHashEntry<TKey, IHashEntry<TKey, TValue>>>>

Protected _disposableObjectName

_disposableObjectName: string

Private _entries

_entries: LinkedNodeList<IHashEntry<TKey, TValue>>

Protected _equalityComparer

_equalityComparer: EqualityComparison<IKeyValuePair<TKey, TValue>>

Private _keyComparer

_keyComparer: Selector<TKey, any>

Protected _version

_version: number

Accessors

count

  • get count(): number

  • Returns number

isReadOnly

  • get isReadOnly(): boolean

isUpdating

  • get isUpdating(): boolean

keys

  • get keys(): TKey[]

  • Returns TKey[]

linq

values

  • get values(): TValue[]

  • Returns TValue[]

wasDisposed

  • get wasDisposed(): boolean

Methods

Protected _addInternal

Protected _clearInternal

  • _clearInternal(): number

Private _getBucket

  • Parameters

    • hash: string
    • Optional createIfMissing: boolean

    Returns LinkedNodeList<IHashEntry<TKey, IHashEntry<TKey, TValue>>>

Private _getBucketEntry

Protected _getEntry

Protected _importEntries

Protected _incrementModified

  • _incrementModified(): void

Protected _onDispose

  • _onDispose(): void

Protected _onModified

  • _onModified(): void

Protected _onValueModified

  • _onValueModified(key: TKey, value: TValue, old: TValue): void

  • Parameters

    • key: TKey
    • value: TValue
    • old: TValue

    Returns void

Protected _removeInternal

  • _removeInternal(item: IKeyValuePair<TKey, TValue> | [TKey, TValue]): number

Protected _setValueInternal

  • _setValueInternal(key: TKey, value: TValue): boolean

  • Parameters

    • key: TKey
    • value: TValue

    Returns boolean

Protected _signalModification

  • _signalModification(increment?: boolean): boolean

add

addByKeyValue

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

Protected assertModifiable

  • assertModifiable(): void

assertVersion

  • assertVersion(version: number): void

  • Parameters

    • version: number

    Returns void

clear

  • clear(): number

contains

containsKey

  • containsKey(key: TKey): boolean

containsValue

  • containsValue(value: TValue): boolean

copyTo

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

  • Type parameters

    Parameters

    • target: TTarget
    • Default value index: number = 0

    Returns TTarget

dispose

  • dispose(): void

forEach

Protected getCount

  • getCount(): number

  • Returns number

getEnumerator

Protected getIsReadOnly

  • getIsReadOnly(): boolean

Protected getKeys

  • getKeys(): TKey[]

  • Returns TKey[]

getValue

  • getValue(key: TKey): TValue

Protected getValues

  • getValues(): TValue[]

  • Returns TValue[]

handleUpdate

  • handleUpdate(closure?: function): boolean

  • Takes a closure that if returning true will propagate an update signal. Multiple update operations can be occurring at once or recursively and the onModified signal will only occur once they're done.

    Parameters

    • Optional closure: function
        • (): boolean

        • Returns boolean

    Returns boolean

importEntries

remove

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

removeByKey

  • removeByKey(key: TKey): boolean

removeByValue

  • removeByValue(value: TValue): number

setValue

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

Protected throwIfDisposed

  • throwIfDisposed(message?: string, objectName?: string): boolean

  • Parameters

    • Optional message: string
    • Default value objectName: string = this._disposableObjectName

    Returns boolean

toArray

Generated using TypeDoc