class OrderedMapNonEmpty<K,V,Tp,TpG>

undocumented

Extends: NonEmptyBase<E>

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

Type parameters

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

Properties

_NonEmptyType

undocumented

Definition

_NonEmptyType: Tp['nonEmpty'];

Overrides

NonEmptyBase._NonEmptyType

context

undocumented

Definition

readonly context: TpG['context'];

Overrides

RMapBase.context

isEmpty

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

Definition

get isEmpty(): false;

Overrides

NonEmptyBase.isEmptyNonEmpty.isEmpty

keyOrder

undocumented

Definition

readonly keyOrder: List.NonEmpty<K>;

Overrides

NonEmpty.keyOrder

size

undocumented

Definition

get size(): number;

Overrides

VariantMapBase.size

sourceMap

undocumented

Definition

readonly sourceMap: TpG['sourceMapNonEmpty'];

Overrides

NonEmpty.sourceMap

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]

addEntries

undocumented

Definition

addEntries(entries: StreamSource<readonly [K, V]>): OrderedMapBase<K, V, Tp> | any;

Parameters

Name	Type	Description
entries	StreamSource<readonly [K, V]>

Overrides

NonEmpty.addEntries

addEntry

undocumented

Definition

addEntry(entry: readonly [K, V]): WithKeyValue<Tp, K, V>['nonEmpty'];

Parameters

Name	Type	Description
entry	readonly [K, V]

Overrides

RMapBase.addEntry

asNormal

Returns this typed as a possibly-empty collection type.

Definition

asNormal(): any;

Overrides

NonEmptyBase.asNormal, NonEmpty.asNormal

assumeNonEmpty

Returns this, since the collection is already known to be non-empty.

Definition

assumeNonEmpty(): this;

Overrides

NonEmptyBase.assumeNonEmpty, NonEmpty.assumeNonEmpty

copy

undocumented

Definition

copy(keyOrder?: List.NonEmpty<K>, sourceMap?: TpG["sourceMapNonEmpty"]): TpG['nonEmpty'];

Parameters

Name	Type	Description
keyOrder	List.NonEmpty<K>
sourceMap	TpG["sourceMapNonEmpty"]

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

VariantMapBase.filter

forEach

undocumented

Definition

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

Parameters

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

Overrides

VariantMapBase.forEach

get

undocumented

Definition

get<UK, O>(key: RelatedTo<K, UK>, otherwise?: OptLazy<O>): V | O;

Type parameters

Name	Description
UK
O

Parameters

Name	Type	Description
key	RelatedTo<K, UK>
otherwise	OptLazy<O>

Overrides

VariantMapBase.get

hasKey

undocumented

Definition

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

Type parameters

Name	Description
UK

Parameters

Name	Type	Description
key	RelatedTo<K, UK>

Overrides

VariantMapBase.hasKey

mapValues

undocumented

Definition

mapValues<V2>(mapFun: (value: V, key: K) => V2): any;

Type parameters

Name	Description
V2

Parameters

Name	Type	Description
mapFun	(value: V, key: K) => V2

Overrides

NonEmpty.mapValues

modifyAt

undocumented

Definition

modifyAt(key: K, options: {
    ifNew?: OptLazyOr<V, Token>;
    ifExists?: (currentValue: V, remove: Token) => V | Token;
  }): TpG['normal'];

Parameters

Name	Type	Description
key	K
options	{     ifNew?: OptLazyOr<V, Token>;     ifExists?: (currentValue: V, remove: Token) => V | Token;   }

Overrides

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

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

VariantMapBase.removeKey

removeKeyAndGet

undocumented

Definition

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

Type parameters

Name	Description
UK

Parameters

Name	Type	Description
key	RelatedTo<K, UK>

Overrides

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

VariantMapBase.removeKeys

set

undocumented

Definition

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

Parameters

Name	Type	Description
key	K
value	V

Overrides

RMapBase.set

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

RMapBase.toBuilder

toJSON

undocumented

Definition

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

Overrides

VariantMapBase.toJSON

toString

undocumented

Definition

toString(): string;

Overrides

VariantMapBase.toString

updateAt

undocumented

Definition

updateAt<UK>(key: RelatedTo<K, UK>, update: Update<V>): any;

Type parameters

Name	Description
UK

Parameters

Name	Type	Description
key	RelatedTo<K, UK>
update	Update<V>

Overrides

NonEmpty.updateAt