Skip to main content

class MultiMapNonEmpty<K,V,Tp,TpG>

undocumented

Extends: NonEmptyBase<E>

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

Type parameters

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

Properties

context

undocumented

Definition

readonly context: TpG['context'];

Overrides

MultiMapBase.context

isEmpty

undocumented

Definition

get isEmpty(): false;

Overrides

NonEmptyBase.isEmptyNonEmpty.isEmpty

keyMap

undocumented

Definition

readonly keyMap: TpG['keyMapNonEmpty'];

Overrides

NonEmpty.keyMap

keySize

undocumented

Definition

get keySize(): number;

Overrides

VariantMultiMapBase.keySize

size

undocumented

Definition

readonly size: number;

Overrides

VariantMultiMapBase.size

Methods

[Symbol.iterator]

undocumented

add

undocumented

Definition

add(key: K, value: V): TpG['nonEmpty'];

Parameters

NameTypeDescription
keyK
valueV

Overrides

MultiMapBase.add

addEntries

undocumented

Definition

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

Parameters

NameTypeDescription
entriesStreamSource<readonly [K, V]>

Overrides

NonEmpty.addEntries

asNormal

undocumented

Definition

asNormal(): any;

Overrides

NonEmptyBase.asNormal, NonEmpty.asNormal

assumeNonEmpty

undocumented

Definition

assumeNonEmpty(): any;

Overrides

NonEmptyBase.assumeNonEmpty, NonEmpty.assumeNonEmpty

copy

undocumented

Definition

copy(keyMap: TpG['keyMapNonEmpty'], size: number): TpG['nonEmpty'];

Parameters

NameTypeDescription
keyMapTpG['keyMapNonEmpty']
sizenumber

copyE

undocumented

Definition

copyE(keyMap: TpG['keyMap'], size: number): TpG['normal'];

Parameters

NameTypeDescription
keyMapTpG['keyMap']
sizenumber

filter

undocumented

Definition

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

Parameters

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

Overrides

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

VariantMultiMapBase.forEach

getValues

undocumented

Definition

getValues<U>(key: RelatedTo<K, U>): TpG['keyMapValues'];

Type parameters

NameDescription
U

Parameters

NameTypeDescription
keyRelatedTo<K, U>

Overrides

VariantMultiMapBase.getValues

hasEntry

undocumented

Definition

hasEntry<U>(key: RelatedTo<K, U>, value: V): boolean;

Type parameters

NameDescription
U

Parameters

NameTypeDescription
keyRelatedTo<K, U>
valueV

Overrides

VariantMultiMapBase.hasEntry

hasKey

undocumented

Definition

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

Type parameters

NameDescription
U

Parameters

NameTypeDescription
keyRelatedTo<K, U>

Overrides

VariantMultiMapBase.hasKey

modifyAt

undocumented

Definition

modifyAt(atKey: K, options: {
    ifNew?: OptLazy<StreamSource<V>>;
    ifExists?: (currentValues: TpG['keyMapValuesNonEmpty']) => StreamSource<V>;
  }): TpG['normal'];

Parameters

NameTypeDescription
atKeyK
options{
    ifNew?: OptLazy<StreamSource<V>>;
    ifExists?: (currentValues: TpG['keyMapValuesNonEmpty']) => StreamSource<V>;
  }

Overrides

MultiMapBase.modifyAt

nonEmpty

undocumented

Definition

nonEmpty(): true;

Overrides

NonEmptyBase.nonEmpty, NonEmpty.nonEmpty

removeEntries

undocumented

Definition

removeEntries<UK, UV>(entries: StreamSource<[RelatedTo<K, UK>, RelatedTo<V, UV>]>): TpG['normal'];

Type parameters

NameDescription
UK
UV

Parameters

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

Overrides

VariantMultiMapBase.removeEntries

removeEntry

undocumented

Definition

removeEntry<UK, UV>(key: RelatedTo<K, UK>, value: RelatedTo<V, UV>): TpG['normal'];

Type parameters

NameDescription
UK
UV

Parameters

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

Overrides

VariantMultiMapBase.removeEntry

removeKey

undocumented

Definition

removeKey<UK>(key: RelatedTo<K, UK>): TpG['normal'];

Type parameters

NameDescription
UK

Parameters

NameTypeDescription
keyRelatedTo<K, UK>

Overrides

VariantMultiMapBase.removeKey

removeKeyAndGet

undocumented

Definition

removeKeyAndGet<UK>(key: RelatedTo<K, UK>): [TpG['normal'], TpG['keyMapValuesNonEmpty']] | undefined;

Type parameters

NameDescription
UK

Parameters

NameTypeDescription
keyRelatedTo<K, UK>

Overrides

VariantMultiMapBase.removeKeyAndGet

removeKeys

undocumented

Definition

removeKeys<UK>(keys: StreamSource<RelatedTo<K, UK>>): TpG['normal'];

Type parameters

NameDescription
UK

Parameters

NameTypeDescription
keysStreamSource<RelatedTo<K, UK>>

Overrides

VariantMultiMapBase.removeKeys

setValues

undocumented

Definition

setValues(key: K, values: any): any;

Parameters

NameTypeDescription
keyK
valuesany

Overrides

MultiMapBase.setValues

stream

undocumented

Definition

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

Overrides

NonEmptyBase.stream, NonEmpty.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(): ArrayNonEmpty<[K, V]>;

Overrides

NonEmpty.toArray

toBuilder

undocumented

Definition

toBuilder(): TpG['builder'];

Overrides

MultiMapBase.toBuilder

toJSON

undocumented

Definition

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

Overrides

VariantMultiMapBase.toJSON

toString

undocumented

Definition

toString(): string;

Overrides

VariantMultiMapBase.toString