Skip to main content

class BiMultiMapNonEmpty<K,V,Tp,TpG>

undocumented

Extends: NonEmptyBase<E>

Implements: BiMultiMapBase.NonEmpty<K,V,Tp>

Type parameters

NameConstraintsDefaultDescription
Kundocumented
Vundocumented
TpContextTypesImplundocumented
TpGWithKeyValue<Tp, K, V> WithKeyValue<Tp, K, V>undocumented

Properties

context

undocumented

Definition

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

Overrides

BiMultiMapBase.context

isEmpty

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

Definition

readonly isEmpty: false;

example
HashBiMultiMap.of([1, 1], [2, 2]).isEmpty   // => false

Overrides

BiMultiMapBase.isEmptyNonEmpty.isEmptyNonEmptyBase.isEmpty

keySize

undocumented

Definition

get keySize(): number;

Overrides

BiMultiMapBase.keySize

keyValueMultiMap

undocumented

Definition

readonly keyValueMultiMap: TpG['keyValueMultiMapNonEmpty'];

Overrides

NonEmpty.keyValueMultiMap

size

undocumented

Definition

get size(): number;

Overrides

BiMultiMapBase.size

valueKeyMultiMap

undocumented

Definition

readonly valueKeyMultiMap: TpG['valueKeyMultiMapNonEmpty'];

Overrides

NonEmpty.valueKeyMultiMap

Methods

[Symbol.iterator]

undocumented

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

NonEmpty.addEntries

asNormal

undocumented

Definition

asNormal(): any;

Overrides

NonEmpty.asNormal, NonEmptyBase.asNormal

assumeNonEmpty

undocumented

Definition

assumeNonEmpty(): any;

Overrides

BiMultiMapBase.assumeNonEmpty, NonEmptyBase.assumeNonEmpty

filter

undocumented

Definition

filter(pred: (entry: [K, V], index: number, halt: () => void) => boolean): WithKeyValue<Tp, K, V>['normal'];

Parameters

NameTypeDescription
pred(entry: [K, V], index: number, halt: () => void) => boolean

Overrides

BiMultiMapBase.filter

forEach

undocumented

Definition

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

Parameters

NameTypeDescription
f(entry: [K, V], index: number, halt: () => void) => void
stateTraverseState

Overrides

BiMultiMapBase.forEach

getKeys

undocumented

Definition

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

Type parameters

NameDefaultDescription
UVV

Parameters

NameTypeDescription
valueRelatedTo<V, UV>

Overrides

BiMultiMapBase.getKeys

getValues

undocumented

Definition

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

Type parameters

NameDefaultDescription
UKK

Parameters

NameTypeDescription
keyRelatedTo<K, UK>

Overrides

BiMultiMapBase.getValues

hasEntry

undocumented

Definition

hasEntry<UK = K, UV = V>(key: RelatedTo<K, UK>, value: RelatedTo<V, UV>): boolean;

Type parameters

NameDefaultDescription
UKK
UVV

Parameters

NameTypeDescription
keyRelatedTo<K, UK>
valueRelatedTo<V, UV>

Overrides

BiMultiMapBase.hasEntry

hasKey

undocumented

Definition

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

Type parameters

NameDefaultDescription
UKK

Parameters

NameTypeDescription
keyRelatedTo<K, UK>

Overrides

BiMultiMapBase.hasKey

hasValue

undocumented

Definition

hasValue<UV = V>(key: RelatedTo<V, UV>): boolean;

Type parameters

NameDefaultDescription
UVV

Parameters

NameTypeDescription
keyRelatedTo<V, UV>

Overrides

BiMultiMapBase.hasValue

nonEmpty

Returns true since this collection is known to be non-empty

Definition

nonEmpty(): true;

example
HashBiMultiMap.of([1, 1], [2, 2]).nonEmpty()   // => true

Overrides

BiMultiMapBase.nonEmpty, NonEmpty.nonEmpty, NonEmptyBase.nonEmpty

removeEntries

undocumented

Definition

removeEntries<UK = K>(entries: StreamSource<[RelatedTo<K, UK>, V]>): WithKeyValue<Tp, K, V>['normal'];

Type parameters

NameDefaultDescription
UKK

Parameters

NameTypeDescription
entriesStreamSource<[RelatedTo<K, UK>, V]>

Overrides

BiMultiMapBase.removeEntries

removeEntry

undocumented

Definition

removeEntry<UK = K>(key: RelatedTo<K, UK>, value: V): WithKeyValue<Tp, K, V>['normal'];

Type parameters

NameDefaultDescription
UKK

Parameters

NameTypeDescription
keyRelatedTo<K, UK>
valueV

Overrides

BiMultiMapBase.removeEntry

removeKey

undocumented

Definition

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

Type parameters

NameDefaultDescription
UKK

Parameters

NameTypeDescription
keyRelatedTo<K, UK>

Overrides

BiMultiMapBase.removeKey

removeKeys

undocumented

Definition

removeKeys<UK = K>(keys: StreamSource<RelatedTo<K, UK>>): WithKeyValue<Tp, K, V>['normal'];

Type parameters

NameDefaultDescription
UKK

Parameters

NameTypeDescription
keysStreamSource<RelatedTo<K, UK>>

Overrides

BiMultiMapBase.removeKeys

removeValue

undocumented

Definition

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

Type parameters

NameDefaultDescription
UVV

Parameters

NameTypeDescription
valueRelatedTo<V, UV>

Overrides

BiMultiMapBase.removeValue

removeValues

undocumented

Definition

removeValues<UV = V>(values: StreamSource<RelatedTo<V, UV>>): WithKeyValue<Tp, K, V>['normal'];

Type parameters

NameDefaultDescription
UVV

Parameters

NameTypeDescription
valuesStreamSource<RelatedTo<V, UV>>

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

undocumented

Definition

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

Overrides

NonEmpty.stream, NonEmptyBase.stream

streamKeys

undocumented

Definition

streamKeys(): Stream.NonEmpty<K>;

Overrides

NonEmpty.streamKeys

streamValues

undocumented

Definition

streamValues(): Stream.NonEmpty<V>;

Overrides

NonEmpty.streamValues

toArray

undocumented

Definition

toArray(): [K, V][];

Overrides

BiMultiMapBase.toArray

toBuilder

undocumented

Definition

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

Overrides

BiMultiMapBase.toBuilder

toJSON

undocumented

Definition

toJSON(): ToJSON<[K, V[]][], this['context']['typeTag']>;

Overrides

BiMultiMapBase.toJSON

toString

undocumented

Definition

toString(): string;

Overrides

BiMultiMapBase.toString