class MultiMapEmpty<K,V,Tp>

undocumented

Extends: EmptyBase

Implements: MultiMapBase<K,V,Tp>

Type parameters

Name	Constraints	Description
K		undocumented
V		undocumented
Tp	ContextImplTypes	undocumented

Properties

_NonEmptyType

undocumented

Definition

_NonEmptyType: WithKeyValue<Tp, K, V>['nonEmpty'];

Overrides

EmptyBase._NonEmptyType

context

undocumented

Definition

readonly context: WithKeyValue<Tp, K, V>['context'];

Overrides

MultiMapBase.context

isEmpty

Returns true since the collection is empty.

Definition

get isEmpty(): true;

Overrides

EmptyBase.isEmptyVariantMultiMapBase.isEmpty

keyMap

undocumented

Definition

get keyMap(): WithKeyValue<Tp, K, V>['keyMap'];

Overrides

VariantMultiMapBase.keyMap

keySize

undocumented

Definition

get keySize(): 0;

Overrides

VariantMultiMapBase.keySize

length

Returns 0 for the length of the collection.

Definition

get length(): 0;

Overrides

EmptyBase.length

size

Returns 0 for the size of the collection.

Definition

get size(): 0;

Overrides

EmptyBase.sizeVariantMultiMapBase.size

Methods

[Symbol.iterator]

Returns an empty iterator.

Definition

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

Overrides

EmptyBase.[Symbol.iterator], FastIterable.[Symbol.iterator]

add

undocumented

Definition

add(key: K, value: V): WithKeyValue<Tp, K, V>['nonEmpty'];

Parameters

Name	Type	Description
key	K
value	V

Overrides

MultiMapBase.add

addEntries

undocumented

Definition

addEntries(entries: StreamSource<readonly [K, V]>): any;

Parameters

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

Overrides

MultiMapBase.addEntries

assumeNonEmpty

Throws a RimbuError.EmptyCollectionAssumedNonEmptyError, since the collection is empty.

Definition

assumeNonEmpty(): never;

throws

RimbuError.EmptyCollectionAssumedNonEmptyError

Overrides

EmptyBase.assumeNonEmpty, VariantMultiMapBase.assumeNonEmpty

filter

Returns this, since filtering an empty collection is still empty.

Definition

filter(): any;

Overrides

EmptyBase.filter, VariantMultiMapBase.filter

forEach

Performs no action, since there are no elements.

Definition

forEach(): void;

Overrides

EmptyBase.forEach, VariantMultiMapBase.forEach

getValues

undocumented

Definition

getValues(): WithKeyValue<Tp, K, V>['keyMapValues'];

Overrides

VariantMultiMapBase.getValues

hasEntry

undocumented

Definition

hasEntry(): false;

Overrides

VariantMultiMapBase.hasEntry

hasKey

undocumented

Definition

hasKey(): false;

Overrides

VariantMultiMapBase.hasKey

modifyAt

undocumented

Definition

modifyAt(atKey: K, options: {
    ifNew?: OptLazy<StreamSource<V>>;
  }): WithKeyValue<Tp, K, V>['normal'];

Parameters

Name	Type	Description
atKey	K
options	{     ifNew?: OptLazy<StreamSource<V>>;   }

Overrides

MultiMapBase.modifyAt

nonEmpty

Returns false, keeping the type narrowed to the empty variant.

Definition

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

Overrides

EmptyBase.nonEmpty, VariantMultiMapBase.nonEmpty

remove

Returns this, since removing from an empty collection has no effect.

Definition

remove(): any;

Overrides

EmptyBase.remove

removeEntries

undocumented

Definition

removeEntries(): WithKeyValue<Tp, K, V>['normal'];

Overrides

VariantMultiMapBase.removeEntries

removeEntry

undocumented

Definition

removeEntry(): WithKeyValue<Tp, K, V>['normal'];

Overrides

VariantMultiMapBase.removeEntry

removeKey

undocumented

Definition

removeKey(): WithKeyValue<Tp, K, V>['normal'];

Overrides

VariantMultiMapBase.removeKey

removeKeyAndGet

undocumented

Definition

removeKeyAndGet(): undefined;

Overrides

VariantMultiMapBase.removeKeyAndGet

removeKeys

undocumented

Definition

removeKeys(): WithKeyValue<Tp, K, V>['normal'];

Overrides

VariantMultiMapBase.removeKeys

setValues

undocumented

Definition

setValues(key: K, values: StreamSource<V>): WithKeyValue<Tp, K, V>['nonEmpty'];

Parameters

Name	Type	Description
key	K
values	StreamSource<V>

Overrides

MultiMapBase.setValues

stream

Returns an empty Stream.

Definition

stream(): Stream<any>;

Overrides

EmptyBase.stream, VariantMultiMapBase.stream

streamKeys

undocumented

Definition

streamKeys(): Stream<K>;

Overrides

VariantMultiMapBase.streamKeys

streamValues

undocumented

Definition

streamValues(): Stream<V>;

Overrides

VariantMultiMapBase.streamValues

toArray

Returns an empty array.

Definition

toArray(): [];

Overrides

EmptyBase.toArray, VariantMultiMapBase.toArray

toBuilder

undocumented

Definition

toBuilder(): WithKeyValue<Tp, K, V>['builder'];

Overrides

MultiMapBase.toBuilder

toJSON

undocumented

Definition

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

Overrides

VariantMultiMapBase.toJSON

toString

undocumented

Definition

toString(): string;

Overrides

VariantMultiMapBase.toString