class HashMapBlock<K,V>

undocumented

Extends: HashMapNonEmptyBase<K,V>

Type parameters

Name	Description
K	undocumented
V	undocumented

Properties

_NonEmptyType

undocumented

Definition

_NonEmptyType: HashMap.NonEmpty<K, V>;

Overrides

NonEmptyBase._NonEmptyTypeHashMapNonEmptyBase._NonEmptyType

context

undocumented

Definition

readonly context: HashMapContext<K>;

Overrides

HashMapNonEmptyBase.context

entries

undocumented

Definition

readonly entries: readonly (readonly [K, V])[] | null;

entrySets

undocumented

Definition

readonly entrySets: readonly MapEntrySet<K, V>[] | null;

isEmpty

undocumented

Definition

get isEmpty(): false;

Overrides

NonEmptyBase.isEmpty

level

undocumented

Definition

readonly level: number;

size

undocumented

Definition

readonly size: number;

Overrides

HashMapNonEmptyBase.size

Methods

[Symbol.iterator]

undocumented

Definition

[Symbol.iterator](): FastIterator<E>;

Overrides

NonEmptyBase.[Symbol.iterator]

addEntries

Returns the collection with the entries from the given StreamSource entries added.

Definition

addEntries(entries: StreamSource<readonly [K, V]>): HashMap.NonEmpty<K, V>;

Parameters

Name	Type	Description
entries	StreamSource<readonly [K, V]>

example

HashMap.of([1, 'a']).addEntries([[2, 'b']]).toArray()   // => [[1, 'a'], [2, 'b']]

Overrides

NonEmpty.addEntries, HashMapNonEmptyBase.addEntries

addEntry

undocumented

Definition

addEntry(entry: readonly [K, V], hash?: number): HashMap<K, V> | any;

Parameters

Name	Type	Description
entry	readonly [K, V]
hash	number

Overrides

HashMapNonEmptyBase.addEntry

asNormal

undocumented

Definition

asNormal(): this;

Overrides

NonEmptyBase.asNormal, HashMapNonEmptyBase.asNormal

assumeNonEmpty

undocumented

Definition

assumeNonEmpty(): this;

Overrides

NonEmptyBase.assumeNonEmpty

copy

undocumented

Definition

copy(entries?: readonly (readonly [K, V])[] |null, entrySets?: readonlyMapEntrySet<K, V>[] |null, size?: number):HashMapBlock<K, V>;

Parameters

Name	Type	Description
entries	readonly (readonly [K, V])[] | null
entrySets	readonly MapEntrySet<K, V>[] | null
size	number

filter

undocumented

Definition

filter(pred: (entry: readonly [K, V], index: number, halt: () => void) => boolean, options?: {
    negate?: boolean;
  }): HashMap<K, V>;

Parameters

Name	Type	Description
pred	(entry: readonly [K, V], index: number, halt: () => void) => boolean
options	{     negate?: boolean;   }

Overrides

HashMapNonEmptyBase.filter

forEach

undocumented

Definition

forEach(f: (entry: readonly [K, V], index: number, halt: () => void) => void, options?: {
    state?: TraverseState;
  }): void;

Parameters

Name	Type	Description
f	(entry: readonly [K, V], index: number, halt: () => void) => void
options	{     state?: TraverseState;   }

Overrides

HashMapNonEmptyBase.forEach

get

undocumented

Definition

get<UK, O>(key: RelatedTo<K, UK>, otherwise?: OptLazy<O>, hash?: number): V | O;

Type parameters

Name	Description
UK
O

Parameters

Name	Type	Description
key	RelatedTo<K, UK>
otherwise	OptLazy<O>
hash	number

Overrides

HashMapNonEmptyBase.get

hasKey

undocumented

Definition

hasKey<U>(key: RelatedTo<K, U>): boolean;

Type parameters

Name	Description
U

Parameters

Name	Type	Description
key	RelatedTo<K, U>

Overrides

HashMapNonEmptyBase.hasKey

mapValues

undocumented

Definition

mapValues<V2>(mapFun: (value: V, key: K) => V2): HashMap.NonEmpty<K, V2>;

Type parameters

Name	Description
V2

Parameters

Name	Type	Description
mapFun	(value: V, key: K) => V2

Overrides

HashMapNonEmptyBase.mapValues

modifyAt

undocumented

Definition

modifyAt(atKey: K, options: {
    ifNew?: OptLazyOr<V, Token>;
    ifExists?: ((currentEntry: V, remove: Token) => V |Token)| V;
  }, atKeyHash?: number): HashMap<K, V>;

Parameters

Name	Type	Description
atKey	K
options	{     ifNew?: OptLazyOr<V, Token>;     ifExists?: ((currentEntry: V, remove: Token) => V |Token)| V;   }
atKeyHash	number

Overrides

HashMapNonEmptyBase.modifyAt

nonEmpty

undocumented

Definition

nonEmpty(): this is this['_NonEmptyType'];

Overrides

NonEmptyBase.nonEmpty

removeKey

undocumented

Definition

removeKey<UK>(key: RelatedTo<K, UK>): HashMap<K, V>;

Type parameters

Name	Description
UK

Parameters

Name	Type	Description
key	RelatedTo<K, UK>

Overrides

HashMapNonEmptyBase.removeKey

removeKeyAndGet

undocumented

Definition

removeKeyAndGet<UK>(key: RelatedTo<K, UK>): [HashMap<K, V>, V] | undefined;

Type parameters

Name	Description
UK

Parameters

Name	Type	Description
key	RelatedTo<K, UK>

Overrides

HashMapNonEmptyBase.removeKeyAndGet

removeKeys

undocumented

Definition

removeKeys<UK>(keys: StreamSource<RelatedTo<K, UK>>): HashMap<K, V>;

Type parameters

Name	Description
UK

Parameters

Name	Type	Description
keys	StreamSource<RelatedTo<K, UK>>

Overrides

HashMapNonEmptyBase.removeKeys

set

Returns the collection with the given key associated to the given value.

Definition

set(key: K, value: V): HashMap.NonEmpty<K, V>;

Parameters

Name	Type	Description
key	K
value	V

example

HashMap.of([1, 'a']).set(2, 'b').toArray()   // => [[1, 'a'], [2, 'b']]
HashMap.of([1, 'a']).set(1, 'b').toArray()   // => [[1, 'b']]

note

if the key is already associated, the previous value will be 'replaced'

Overrides

RMapBase.set, HashMapNonEmptyBase.set

stream

undocumented

Definition

stream(): Stream.NonEmpty<readonly [K, V]>;

Overrides

NonEmptyBase.stream

streamKeys

undocumented

Definition

streamKeys(): Stream.NonEmpty<K>;

Overrides

HashMapNonEmptyBase.streamKeys

streamValues

undocumented

Definition

streamValues(): Stream.NonEmpty<V>;

Overrides

HashMapNonEmptyBase.streamValues

toArray

undocumented

Definition

toArray(): ArrayNonEmpty<[K, V]>;

Overrides

HashMapNonEmptyBase.toArray

toBuilder

Returns a builder object containing the entries of this collection.

Definition

toBuilder(): HashMap.Builder<K, V>;

example

const builder: HashMap.Builder<number, string> = HashMap.of([1, 'a'], [2, 'b']).toBuilder()

Overrides

RMapBase.toBuilder, HashMapNonEmptyBase.toBuilder

toJSON

undocumented

Definition

toJSON(): ToJSON<(readonly [K, V])[]>;

Overrides

HashMapNonEmptyBase.toJSON

toString

undocumented

Definition

toString(): string;

Overrides

HashMapNonEmptyBase.toString

updateAt

Returns the collection where the value associated with given key is updated with the given update value or update function.

Definition

updateAt<UK>(key: RelatedTo<K, UK>, update: Update<V>): HashMap.NonEmpty<K, V>;

Type parameters

Name	Description
UK

Parameters

Name	Type	Description
key	RelatedTo<K, UK>
update	Update<V>

example

const m = HashMap.of([1, 'a'], [2, 'b'])
m.updateAt(3, 'a').toArray()
// => [[1, 'a'], [2, 'b']]
m.updateAt(2, 'c').toArray()
// => [[1, 'a'], [2, 'c']]
m.updateAt(2, v => v + 'z')
// => [[1, 'a'], [2, 'cz]]

Overrides

NonEmpty.updateAt, HashMapNonEmptyBase.updateAt