Skip to main content

class Empty<T>

undocumented

Extends: EmptyBase

Type parameters​

NameDefaultDescription
Tanyundocumented

Properties​

_NonEmptyType​

undocumented

Definition​

_NonEmptyType: List.NonEmpty<T>;

Overrides​

EmptyBase._NonEmptyType

context​

undocumented

Definition​

readonly context: ListContext;

isEmpty​

Returns true since the collection is empty.

Definition​

get isEmpty(): true;

Overrides​

EmptyBase.isEmpty

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

Methods​

[Symbol.iterator]​

Returns an empty iterator.

Definition​

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

Overrides​

EmptyBase.[Symbol.iterator]

append​

undocumented

Definition​

append(value: T): List.NonEmpty<T>;

Parameters​

NameTypeDescription
valueT

assumeNonEmpty​

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

Definition​

assumeNonEmpty(): never;
throws

RimbuError.EmptyCollectionAssumedNonEmptyError

Overrides​

EmptyBase.assumeNonEmpty

collect​

undocumented

Definition​

collect(): any;

concat​

undocumented

Definition​

concat<T2>(...sources: ArrayNonEmpty<StreamSource<T2>>): any;

Type parameters​

NameDescription
T2

Parameters​

NameTypeDescription
sourcesArrayNonEmpty<StreamSource<T2>>

drop​

undocumented

Definition​

drop(): this;

filter​

undocumented

Definition​

filter(): any;

Overrides​

EmptyBase.filter

first​

undocumented

Definition​

first<O>(otherwise?: OptLazy<O>): O;

Type parameters​

NameDescription
O

Parameters​

NameTypeDescription
otherwiseOptLazy<O>

flatMap​

undocumented

Definition​

flatMap(): any;

forEach​

Performs no action, since there are no elements.

Definition​

forEach(): void;

Overrides​

EmptyBase.forEach

get​

undocumented

Definition​

get<O>(index: number, otherwise?: OptLazy<O>): O;

Type parameters​

NameDescription
O

Parameters​

NameTypeDescription
indexnumber
otherwiseOptLazy<O>

insert​

undocumented

Definition​

insert(index: number, values: StreamSource<T>): any;

Parameters​

NameTypeDescription
indexnumber
valuesStreamSource<T>

last​

undocumented

Definition​

last<O>(otherwise?: OptLazy<O>): O;

Type parameters​

NameDescription
O

Parameters​

NameTypeDescription
otherwiseOptLazy<O>

map​

undocumented

Definition​

map(): any;

mapPure​

undocumented

Definition​

mapPure(): any;

nonEmpty​

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

Definition​

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

Overrides​

EmptyBase.nonEmpty

padTo​

undocumented

Definition​

padTo(length: number, fill: any): List<any>;

Parameters​

NameTypeDescription
lengthnumber
fillany

prepend​

undocumented

Definition​

prepend(value: T): List.NonEmpty<T>;

Parameters​

NameTypeDescription
valueT

remove​

undocumented

Definition​

remove(): this;

Overrides​

EmptyBase.remove

repeat​

undocumented

Definition​

repeat(): this;

reversed​

undocumented

Definition​

reversed(): this;

rotate​

undocumented

Definition​

rotate(): this;

slice​

undocumented

Definition​

slice(): this;

sort​

undocumented

Definition​

sort(): this;

splice​

undocumented

Definition​

splice(options: {
    insert?: StreamSource<T>;
  }): any;

Parameters​

NameTypeDescription
options{
    insert?: StreamSource<T>;
  }

stream​

Returns an empty Stream.

Definition​

stream(): Stream<any>;

Overrides​

EmptyBase.stream

streamRange​

undocumented

Definition​

streamRange(): Stream<T>;

structure​

undocumented

Definition​

structure(): string;

take​

undocumented

Definition​

take(): this;

toArray​

undocumented

Definition​

toArray(): [];

Overrides​

EmptyBase.toArray

toBuilder​

undocumented

Definition​

toBuilder(): List.Builder<T>;

toJSON​

undocumented

Definition​

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

toString​

undocumented

Definition​

toString(): string;

updateAt​

undocumented

Definition​

updateAt(): this;