Interface ImmutableHashDictionary<K, V>

Immutable view of the HashDictionary.

interface ImmutableHashDictionary<K extends OpaqueHash, V> {
    get size(): number;
    "[iterator]"(): Iterator<[K, V], any, any>;
    get(key: K): V | undefined;
    has(key: K): boolean;
    keys(): Generator<K>;
    toSortedArray(compare: Comparator<K>): V[];
    values(): Generator<V>;
}

Type Parameters

K extends OpaqueHash
V

Hierarchy

Iterable<[K, V]>
- ImmutableHashDictionary

Implemented by

HashDictionary

Index

Accessors

Methods

[iterator] get has keys toSortedArray values

Accessors

size

get size(): number
Return number of items in the dictionary.

Returns number
- Defined in packages/core/collections/hash-dictionary.ts:7

Methods

[iterator]

"[iterator]"(): Iterator<[K, V], any, any>
Returns Iterator<[K, V], any, any>
Inherited from Iterable.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:49

get

get(key: K): V | undefined
Get the value under given key or undefined if the value is not present.
Parameters
- key: K
Returns V | undefined
- Defined in packages/core/collections/hash-dictionary.ts:11

has

has(key: K): boolean
Return true if the key is present in the dictionary.
Parameters
- key: K
Returns boolean
- Defined in packages/core/collections/hash-dictionary.ts:9

keys

keys(): Generator<K>
Iterator over keys of the dictionary.

Returns Generator<K>
- Defined in packages/core/collections/hash-dictionary.ts:14

toSortedArray

toSortedArray(compare: Comparator<K>): V[]
Returns an array of the map's values, sorted by their corresponding keys
Parameters
- compare: Comparator<K>
Returns V[]
- Defined in packages/core/collections/hash-dictionary.ts:20

values

values(): Generator<V>
Iterator over values of the dictionary.

Returns Generator<V>
- Defined in packages/core/collections/hash-dictionary.ts:17