Skip to main content

class MultiSetEmpty<T,Tp>

undocumented

Extends: EmptyBase

Implements: MultiSetBase<T,Tp>

Type parameters​

NameConstraintsDescription
Tundocumented
TpContextImplTypesundocumented

Properties​

_NonEmptyType​

undocumented

Definition​

_NonEmptyType: WithElem<Tp, T>['nonEmpty'];

Overrides​

EmptyBase._NonEmptyType

context​

undocumented

Definition​

readonly context: WithElem<Tp, T>['context'];

Overrides​

MultiSetBase.context

countMap​

undocumented

Definition​

get countMap(): WithElem<Tp, T>['countMap'];

Overrides​

VariantMultiSetBase.countMap

isEmpty​

Returns true since the collection is empty.

Definition​

get isEmpty(): true;

Overrides​

EmptyBase.isEmptyVariantMultiSetBase.isEmpty

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

sizeDistinct​

undocumented

Definition​

get sizeDistinct(): 0;

Overrides​

VariantMultiSetBase.sizeDistinct

Methods​

[Symbol.iterator]​

Returns an empty iterator.

add​

undocumented

Definition​

add(elem: T, amount?: number): WithElem<Tp, T>['nonEmpty'];

Parameters​

NameTypeDescription
elemT
amountnumber

Overrides​

MultiSetBase.add

addAll​

undocumented

Definition​

addAll(values: StreamSource<T>): WithElem<Tp, T>['nonEmpty'];

Parameters​

NameTypeDescription
valuesStreamSource<T>

Overrides​

MultiSetBase.addAll

addEntries​

undocumented

Definition​

addEntries(entries: StreamSource<readonly [T, number]>): WithElem<Tp, T>['normal'];

Parameters​

NameTypeDescription
entriesStreamSource<readonly [T, number]>

Overrides​

MultiSetBase.addEntries

assumeNonEmpty​

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

Definition​

assumeNonEmpty(): never;

throws

RimbuError.EmptyCollectionAssumedNonEmptyError

Overrides​

EmptyBase.assumeNonEmpty, VariantMultiSetBase.assumeNonEmpty

count​

undocumented

Definition​

count(): 0;

Overrides​

VariantMultiSetBase.count

filter​

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

Definition​

filter(): any;

Overrides​

EmptyBase.filter

filterEntries​

undocumented

Definition​

filterEntries(): WithElem<Tp, T>['normal'];

Overrides​

VariantMultiSetBase.filterEntries

forEach​

undocumented

Definition​

forEach(): void;

Overrides​

EmptyBase.forEach, VariantMultiSetBase.forEach

has​

undocumented

Definition​

has(): false;

Overrides​

VariantMultiSetBase.has

modifyCount​

undocumented

Definition​

modifyCount(value: T, update: (currentCount: number) => number): WithElem<Tp, T>['normal'];

Parameters​

NameTypeDescription
valueT
update(currentCount: number) => number

Overrides​

MultiSetBase.modifyCount

nonEmpty​

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

Definition​

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

Overrides​

EmptyBase.nonEmpty, VariantMultiSetBase.nonEmpty

remove​

undocumented

Definition​

remove(): WithElem<Tp, T>['normal'];

Overrides​

EmptyBase.remove, VariantMultiSetBase.remove

removeAllEvery​

undocumented

Definition​

removeAllEvery(): WithElem<Tp, T>['normal'];

Overrides​

VariantMultiSetBase.removeAllEvery

removeAllSingle​

undocumented

Definition​

removeAllSingle(): WithElem<Tp, T>['normal'];

Overrides​

VariantMultiSetBase.removeAllSingle

setCount​

undocumented

Definition​

setCount(elem: T, amount: number): WithElem<Tp, T>['normal'];

Parameters​

NameTypeDescription
elemT
amountnumber

Overrides​

MultiSetBase.setCount

stream​

Returns an empty Stream.

Definition​

stream(): Stream<any>;

Overrides​

EmptyBase.stream, VariantMultiSetBase.stream

streamDistinct​

undocumented

Definition​

streamDistinct(): Stream<T>;

Overrides​

VariantMultiSetBase.streamDistinct

toArray​

undocumented

Definition​

toArray(): [];

Overrides​

EmptyBase.toArray, VariantMultiSetBase.toArray

toBuilder​

undocumented

Definition​

toBuilder(): WithElem<Tp, T>['builder'];

Overrides​

MultiSetBase.toBuilder

toJSON​

undocumented

Definition​

toJSON(): ToJSON<[any, number][]>;

Overrides​

VariantMultiSetBase.toJSON

toString​

undocumented

Definition​

toString(): string;

Overrides​

VariantMultiSetBase.toString