class OrderedSetNonEmpty<T,Tp,TpG>

undocumented

Extends: NonEmptyBase<E>

Implements: OrderedSetBase.NonEmpty<T,Tp>

Type parameters

Name	Constraints	Default	Description
T			undocumented
Tp	OrderedSetTypes		undocumented
TpG	WithElem<Tp, T>	WithElem<Tp, T>	undocumented

Properties

_NonEmptyType

undocumented

Definition

_NonEmptyType: Tp['nonEmpty'];

Overrides

NonEmptyBase._NonEmptyType

context

undocumented

Definition

readonly context: WithElem<Tp, T>['context'];

Overrides

RSetBase.context

isEmpty

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

Definition

get isEmpty(): false;

Overrides

NonEmptyBase.isEmptyNonEmpty.isEmpty

order

undocumented

Definition

readonly order: List.NonEmpty<T>;

Overrides

NonEmpty.order

size

undocumented

Definition

get size(): number;

Overrides

VariantSetBase.size

sourceSet

undocumented

Definition

readonly sourceSet: TpG['sourceSetNonEmpty'];

Overrides

NonEmpty.sourceSet

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(value: T): TpG['nonEmpty'];

Parameters

Name	Type	Description
value	T

Overrides

NonEmpty.add

addAll

undocumented

Definition

addAll(values: StreamSource<T>): TpG['nonEmpty'];

Parameters

Name	Type	Description
values	StreamSource<T>

Overrides

NonEmpty.addAll

asNormal

undocumented

Definition

asNormal(): any;

Overrides

NonEmptyBase.asNormal, NonEmpty.asNormal

assumeNonEmpty

undocumented

Definition

assumeNonEmpty(): any;

Overrides

NonEmptyBase.assumeNonEmpty, NonEmpty.assumeNonEmpty

copy

undocumented

Definition

copy(order?: List.NonEmpty<T>, sourceSet?: TpG["sourceSetNonEmpty"]): TpG['nonEmpty'];

Parameters

Name	Type	Description
order	List.NonEmpty<T>
sourceSet	TpG["sourceSetNonEmpty"]

difference

undocumented

Definition

difference(other: StreamSource<T>): TpG['normal'];

Parameters

Name	Type	Description
other	StreamSource<T>

Overrides

VariantSetBase.difference

filter

undocumented

Definition

filter(pred: (value: T, index: number, halt: () => void) => boolean, options?: {
    negate?: boolean | undefined;
  }): any;

Parameters

Name	Type	Description
pred	(value: T, index: number, halt: () => void) => boolean
options	{     negate?: boolean | undefined;   }

Overrides

VariantSetBase.filter

forEach

undocumented

Definition

forEach(f: (value: T, index: number, halt: () => void) => void, options?: {
    reversed?: boolean;
    state?: TraverseState;
  }): void;

Parameters

Name	Type	Description
f	(value: T, index: number, halt: () => void) => void
options	{     reversed?: boolean;     state?: TraverseState;   }

Overrides

VariantSetBase.forEach

has

undocumented

Definition

has<U>(value: RelatedTo<T, U>): boolean;

Type parameters

Name	Description
U

Parameters

Name	Type	Description
value	RelatedTo<T, U>

Overrides

VariantSetBase.has

intersect

undocumented

Definition

intersect(other: StreamSource<T>): TpG['normal'];

Parameters

Name	Type	Description
other	StreamSource<T>

Overrides

VariantSetBase.intersect

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

remove

undocumented

Definition

remove<U>(value: RelatedTo<T, U>): TpG['normal'];

Type parameters

Name	Description
U

Parameters

Name	Type	Description
value	RelatedTo<T, U>

Overrides

VariantSetBase.remove

removeAll

undocumented

Definition

removeAll<U>(values: StreamSource<RelatedTo<T, U>>): TpG['normal'];

Type parameters

Name	Description
U

Parameters

Name	Type	Description
values	StreamSource<RelatedTo<T, U>>

Overrides

VariantSetBase.removeAll

stream

undocumented

Definition

stream(options?: {
    reversed?: boolean;
  }): Stream.NonEmpty<T>;

Parameters

Name	Type	Description
options	{     reversed?: boolean;   }

Overrides

NonEmptyBase.stream, NonEmpty.stream

symDifference

undocumented

Definition

symDifference(other: StreamSource<T>): TpG['normal'];

Parameters

Name	Type	Description
other	StreamSource<T>

Overrides

RSetBase.symDifference

toArray

undocumented

Definition

toArray(): ArrayNonEmpty<T>;

Overrides

NonEmpty.toArray

toBuilder

undocumented

Definition

toBuilder(): TpG['builder'];

Overrides

RSetBase.toBuilder

toJSON

undocumented

Definition

toJSON(): ToJSON<T[]>;

Overrides

VariantSetBase.toJSON

toString

undocumented

Definition

toString(): string;

Overrides

VariantSetBase.toString

union

undocumented

Definition

union(other: StreamSource<T>): TpG['nonEmpty'];

Parameters

Name	Type	Description
other	StreamSource<T>

Overrides

NonEmpty.union