Class HashMap<K, V>

An immutable HashMap

Type parameters

K
V

Hierarchy

HashMap

Implements

ICollection<V>

Index

Accessors

Methods

Accessors

asArray

get asArray(): V[]

- Defined in src/immutable/hashMap.ts:14
Refer ICollection.asArray

Returns V[]

isEmpty

get isEmpty(): boolean

- Defined in src/immutable/hashMap.ts:25
Refer ICollection.isEmpty

Returns boolean

Methods

delete

delete(k: K): HashMap<K, V>

- Defined in src/immutable/hashMap.ts:43
Deletes the provided key from the HashMap

Parameters
- k: K
Returns HashMap<K, V>

filter

filter(fn: function): HashMap<K, V>

- Defined in src/immutable/hashMap.ts:54
Refer ICollection.filter

Parameters
- fn: function
  - - (kv: V): boolean
    - Parameters
      - kv: V
      Returns boolean
Returns HashMap<K, V>

fold

fold<S>(S: S, fn: function): S

- Defined in src/immutable/hashMap.ts:62
Refer ICollection.fold Use HasMap.fold0 to fold with keys.

Type parameters
- S
Parameters
- S: S
- fn: function
  - - (kv: V, S: S): S
    - Parameters
      - kv: V
      - S: S
      Returns S
Returns S

fold0

fold0<S>(S: S, fn: function): S

- Defined in src/immutable/hashMap.ts:69
Folds a [[HasMap]] into a value, by calling the function on each key value pair.

Type parameters
- S
Parameters
- S: S
- fn: function
  - - (V: V, K: K, S: S): S
    - Parameters
      - V: V
      - K: K
      - S: S
      Returns S
Returns S

get

get(k: K): Option<V>

- Defined in src/immutable/hashMap.ts:81
Returns value for the provided key

Parameters
- k: K
Returns Option<V>

has

has(k: K): boolean

- Defined in src/immutable/hashMap.ts:88
Returns true if the value exists in the HashMap

Parameters
- k: K
Returns boolean

map

map<B>(ab: function): HashMap<K, B>

- Defined in src/immutable/hashMap.ts:95
Refer ICollection.map

Type parameters
- B
Parameters
- ab: function
  - - (V: V): B
    - Parameters
      - V: V
      Returns B
Returns HashMap<K, B>

set

set(k: K, v: V): HashMap<K, V>

- Defined in src/immutable/hashMap.ts:102
Sets a key value pair and returns a new HashMap.

Parameters
- k: K
- v: V
Returns HashMap<K, V>

Static of

of<K, V>(entries?: ReadonlyArray<keyof [K, V]>): HashMap<K, V>

- Defined in src/immutable/hashMap.ts:32
Creates a new instance of HashMap

Type parameters
- K
- V
Parameters
- Optional entries: ReadonlyArray<keyof [K, V]>
Returns HashMap<K, V>

Generated using TypeDoc