Skip to main content

class BiMultiMapEmpty<K,V,Tp>

undocumented

Extends: EmptyBase

Implements: BiMultiMapBase<K,V,Tp>

Type parameters​

NameConstraintsDescription
Kundocumented
Vundocumented
TpContextTypesImplundocumented

Properties​

_NonEmptyType​

undocumented

Definition​

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

Overrides​

EmptyBase._NonEmptyType

context​

undocumented

Definition​

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

Overrides​

BiMultiMapBase.context

isEmpty​

Returns true since the collection is empty.

Definition​

get isEmpty(): true;

Overrides​

EmptyBase.isEmptyBiMultiMapBase.isEmpty

keySize​

undocumented

Definition​

get keySize(): 0;

Overrides​

BiMultiMapBase.keySize

keyValueMultiMap​

undocumented

Definition​

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

Overrides​

BiMultiMapBase.keyValueMultiMap

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.sizeBiMultiMapBase.size

valueKeyMultiMap​

undocumented

Definition​

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

Overrides​

BiMultiMapBase.valueKeyMultiMap

Methods​

[Symbol.iterator]​

Returns an empty iterator.

add​

undocumented

Definition​

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

Parameters​

NameTypeDescription
keyK
valueV

Overrides​

BiMultiMapBase.add

addEntries​

undocumented

Definition​

addEntries(entries: StreamSource<readonly [K, V]>): WithKeyValue<Tp, K, V>['nonEmpty'];

Parameters​

NameTypeDescription
entriesStreamSource<readonly [K, V]>

Overrides​

BiMultiMapBase.addEntries

assumeNonEmpty​

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

Definition​

assumeNonEmpty(): never;

throws

RimbuError.EmptyCollectionAssumedNonEmptyError

Overrides​

EmptyBase.assumeNonEmpty, BiMultiMapBase.assumeNonEmpty

filter​

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

Definition​

filter(): any;

Overrides​

EmptyBase.filter, BiMultiMapBase.filter

forEach​

Performs no action, since there are no elements.

Definition​

forEach(): void;

Overrides​

EmptyBase.forEach, BiMultiMapBase.forEach

getKeys​

undocumented

Definition​

getKeys(): WithKeyValue<Tp, K, V>['valueMultiMapValues'];

Overrides​

BiMultiMapBase.getKeys

getValues​

undocumented

Definition​

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

Overrides​

BiMultiMapBase.getValues

hasEntry​

undocumented

Definition​

hasEntry(): false;

Overrides​

BiMultiMapBase.hasEntry

hasKey​

undocumented

Definition​

hasKey(): false;

Overrides​

BiMultiMapBase.hasKey

hasValue​

undocumented

Definition​

hasValue(): false;

Overrides​

BiMultiMapBase.hasValue

nonEmpty​

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

Definition​

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

Overrides​

EmptyBase.nonEmpty, BiMultiMapBase.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​

BiMultiMapBase.removeEntries

removeEntry​

undocumented

Definition​

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

Overrides​

BiMultiMapBase.removeEntry

removeKey​

undocumented

Definition​

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

Overrides​

BiMultiMapBase.removeKey

removeKeys​

undocumented

Definition​

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

Overrides​

BiMultiMapBase.removeKeys

removeValue​

undocumented

Definition​

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

Overrides​

BiMultiMapBase.removeValue

removeValues​

undocumented

Definition​

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

Overrides​

BiMultiMapBase.removeValues

setKeys​

undocumented

Definition​

setKeys(value: V, keys: StreamSource<K>): WithKeyValue<Tp, K, V>['nonEmpty'];

Parameters​

NameTypeDescription
valueV
keysStreamSource<K>

Overrides​

BiMultiMapBase.setKeys

setValues​

undocumented

Definition​

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

Parameters​

NameTypeDescription
keyK
valuesStreamSource<V>

Overrides​

BiMultiMapBase.setValues

stream​

Returns an empty Stream.

Definition​

stream(): Stream<any>;

Overrides​

EmptyBase.stream, BiMultiMapBase.stream

streamKeys​

undocumented

Definition​

streamKeys(): Stream<K>;

Overrides​

BiMultiMapBase.streamKeys

streamValues​

undocumented

Definition​

streamValues(): Stream<V>;

Overrides​

BiMultiMapBase.streamValues

toArray​

Returns an empty array.

Definition​

toArray(): [];

Overrides​

EmptyBase.toArray, BiMultiMapBase.toArray

toBuilder​

undocumented

Definition​

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

Overrides​

BiMultiMapBase.toBuilder

toJSON​

undocumented

Definition​

toJSON(): ToJSON<any[]>;

Overrides​

BiMultiMapBase.toJSON

toString​

undocumented

Definition​

toString(): string;

Overrides​

BiMultiMapBase.toString