Skip to main content

class OrderedMapEmpty<K,V,Tp>

undocumented

Extends: EmptyBase

Implements: OrderedMapBase<K,V,Tp>

Type parameters​

NameConstraintsDefaultDescription
Kanyundocumented
Vanyundocumented
TpOrderedMapTypesOrderedMapTypesundocumented

Properties​

_NonEmptyType​

undocumented

Definition​

_NonEmptyType: Tp['nonEmpty'];

Overrides​

EmptyBase._NonEmptyType

context​

undocumented

Definition​

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

isEmpty​

Returns true since the collection is empty.

Definition​

get isEmpty(): true;

Overrides​

EmptyBase.isEmpty

keyOrder​

undocumented

Definition​

get keyOrder(): List<K>;

Overrides​

OrderedMapBase.keyOrder

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

sourceMap​

undocumented

Definition​

get sourceMap(): WithKeyValue<Tp, K, V>['sourceMap'];

Overrides​

OrderedMapBase.sourceMap

Methods​

[Symbol.iterator]​

Returns an empty iterator.

Definition​

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

Overrides​

EmptyBase.[Symbol.iterator]

addEntries​

undocumented

Definition​

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

Parameters​

NameTypeDescription
entriesStreamSource<readonly [K, V]>

addEntry​

undocumented

Definition​

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

Parameters​

NameTypeDescription
entryreadonly [K, V]

assumeNonEmpty​

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

Definition​

assumeNonEmpty(): never;
throws

RimbuError.EmptyCollectionAssumedNonEmptyError

Overrides​

EmptyBase.assumeNonEmpty

filter​

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

Definition​

filter(): any;

Overrides​

EmptyBase.filter

forEach​

Performs no action, since there are no elements.

Definition​

forEach(): void;

Overrides​

EmptyBase.forEach

get​

undocumented

Definition​

get<O>(key: K, otherwise?: OptLazy<O>): O;

Type parameters​

NameDescription
O

Parameters​

NameTypeDescription
keyK
otherwiseOptLazy<O>

hasKey​

undocumented

Definition​

hasKey(): false;

mapValues​

undocumented

Definition​

mapValues(): any;

modifyAt​

undocumented

Definition​

modifyAt(key: K, options: {
    ifNew?: OptLazyOr<V, Token>;
  }): WithKeyValue<Tp, K, V>['normal'];

Parameters​

NameTypeDescription
keyK
options{
    ifNew?: OptLazyOr<V, Token>;
  }

nonEmpty​

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

Definition​

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

Overrides​

EmptyBase.nonEmpty

remove​

Returns this, since removing from an empty collection has no effect.

Definition​

remove(): any;

Overrides​

EmptyBase.remove

removeKey​

undocumented

Definition​

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

removeKeyAndGet​

undocumented

Definition​

removeKeyAndGet(): undefined;

removeKeys​

undocumented

Definition​

removeKeys(): WithKeyValue<Tp, K, V>['normal'];

set​

undocumented

Definition​

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

Parameters​

NameTypeDescription
keyK
valueV

stream​

Returns an empty Stream.

Definition​

stream(): Stream<any>;

Overrides​

EmptyBase.stream

streamKeys​

undocumented

Definition​

streamKeys(): Stream<K>;

streamValues​

undocumented

Definition​

streamValues(): Stream<V>;

toArray​

Returns an empty array.

Definition​

toArray(): [];

Overrides​

EmptyBase.toArray

toBuilder​

undocumented

Definition​

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

toJSON​

undocumented

Definition​

toJSON(): ToJSON<any[]>;

toString​

undocumented

Definition​

toString(): string;

updateAt​

undocumented

Definition​

updateAt(): any;