abstract class HashMapNonEmptyBase<K,V>

undocumented

Extends: NonEmptyBase<E>

Extended by: HashMapBlock<K,V>, HashMapCollision<K,V>

Type parameters

Name	Description
K	undocumented
V	undocumented

Properties

_NonEmptyType

undocumented

Definition

_NonEmptyType: HashMap.NonEmpty<K, V>;

Overrides

NonEmptyBase._NonEmptyType

context

undocumented

Definition

abstract get context(): HashMapContext<K>;

isEmpty

Returns false since the collection is known to be non-empty.

Definition

get isEmpty(): false;

Overrides

NonEmptyBase.isEmpty

size

undocumented

Definition

abstract get size(): number;

Methods

[Symbol.iterator]

Returns a fast iterator over the elements of the collection.

Definition

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

Overrides

NonEmptyBase.[Symbol.iterator]

addEntries

undocumented

Definition

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

Parameters

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

addEntry

undocumented

Definition

abstract addEntry(entry: readonly [K, V], hash?: number): HashMap.NonEmpty<K, V>;

Parameters

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

asNormal

undocumented

Definition

asNormal(): this;

Overrides

NonEmptyBase.asNormal

assumeNonEmpty

Returns this, since the collection is already known to be non-empty.

Definition

assumeNonEmpty(): this;

Overrides

NonEmptyBase.assumeNonEmpty

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;   }

forEach

undocumented

Definition

abstract 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;   }

get

undocumented

Definition

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

Type parameters

Name	Description
UK
O

Parameters

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

hasKey

undocumented

Definition

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

Type parameters

Name	Description
U

Parameters

Name	Type	Description
key	RelatedTo<K, U>

mapValues

undocumented

Definition

abstract 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

modifyAt

undocumented

Definition

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

Parameters

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

nonEmpty

Returns true and instructs the compiler to treat the instance as non-empty.

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>

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>

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>>

set

undocumented

Definition

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

Parameters

Name	Type	Description
key	K
value	V

stream

Returns a non-empty Stream containing all elements of the collection.

Definition

abstract stream(): Stream.NonEmpty<E>;

Overrides

NonEmptyBase.stream

streamKeys

undocumented

Definition

streamKeys(): Stream.NonEmpty<K>;

streamValues

undocumented

Definition

streamValues(): Stream.NonEmpty<V>;

toArray

undocumented

Definition

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

toBuilder

undocumented

Definition

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

toJSON

undocumented

Definition

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

toString

undocumented

Definition

toString(): string;

updateAt

undocumented

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>