class MultiMapNonEmpty<K,V,Tp,TpG>

undocumented

Extends: NonEmptyBase<E>

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

Type parameters

Name	Constraints	Default	Description
K			undocumented
V			undocumented
Tp	ContextImplTypes		undocumented
TpG	WithKeyValue<Tp, K, V>	WithKeyValue<Tp, K, V>	undocumented

Properties

_NonEmptyType

undocumented

Definition

_NonEmptyType: TpG['nonEmpty'];

Overrides

NonEmptyBase._NonEmptyType

context

undocumented

Definition

readonly context: TpG['context'];

Overrides

MultiMapBase.context

isEmpty

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

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]

Returns a fast iterator over the elements of the collection.

Definition

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

Overrides

NonEmptyBase.[Symbol.iterator], FastIterable.[Symbol.iterator]

add

undocumented

Definition

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

Parameters

Name	Type	Description
key	K
value	V

Overrides

MultiMapBase.add

addEntries

undocumented

Definition

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

Parameters

Name	Type	Description
entries	StreamSource<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

Name	Type	Description
keyMap	TpG['keyMapNonEmpty']
size	number

copyE

undocumented

Definition

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

Parameters

Name	Type	Description
keyMap	TpG['keyMap']
size	number

filter

undocumented

Definition

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

Parameters

Name	Type	Description
pred	(entry: [K, V], index: number, halt: () => void) => boolean
options	{     negate?: boolean;   }

Overrides

VariantMultiMapBase.filter

forEach

undocumented

Definition

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

Parameters

Name	Type	Description
f	(entry: [K, V], index: number, halt: () => void) => void
options	{     state?: TraverseState;   }

Overrides

VariantMultiMapBase.forEach

getValues

undocumented

Definition

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

Type parameters

Name	Description
U

Parameters

Name	Type	Description
key	RelatedTo<K, U>

Overrides

VariantMultiMapBase.getValues

hasEntry

undocumented

Definition

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

Type parameters

Name	Description
U

Parameters

Name	Type	Description
key	RelatedTo<K, U>
value	V

Overrides

VariantMultiMapBase.hasEntry

hasKey

undocumented

Definition

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

Type parameters

Name	Description
U

Parameters

Name	Type	Description
key	RelatedTo<K, U>

Overrides

VariantMultiMapBase.hasKey

modifyAt

undocumented

Definition

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

Parameters

Name	Type	Description
atKey	K
options	{     ifNew?: OptLazy<StreamSource<V>>;     ifExists?: ((currentValues: TpG['keyMapValuesNonEmpty']) => StreamSource<V>) | StreamSource<V>;   }

Overrides

MultiMapBase.modifyAt

nonEmpty

Returns true and instructs the compiler to treat the instance as non-empty.

Definition

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

Overrides

NonEmptyBase.nonEmpty, NonEmpty.nonEmpty

removeEntries

undocumented

Definition

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

Type parameters

Name	Description
UK
UV

Parameters

Name	Type	Description
entries	StreamSource<[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

Name	Description
UK
UV

Parameters

Name	Type	Description
key	RelatedTo<K, UK>
value	RelatedTo<V, UV>

Overrides

VariantMultiMapBase.removeEntry

removeKey

undocumented

Definition

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

Type parameters

Name	Description
UK

Parameters

Name	Type	Description
key	RelatedTo<K, UK>

Overrides

VariantMultiMapBase.removeKey

removeKeyAndGet

undocumented

Definition

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

Type parameters

Name	Description
UK

Parameters

Name	Type	Description
key	RelatedTo<K, UK>

Overrides

VariantMultiMapBase.removeKeyAndGet

removeKeys

undocumented

Definition

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

Type parameters

Name	Description
UK

Parameters

Name	Type	Description
keys	StreamSource<RelatedTo<K, UK>>

Overrides

VariantMultiMapBase.removeKeys

setValues

undocumented

Definition

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

Parameters

Name	Type	Description
key	K
values	any

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