interface OrderedSetBase.Context<UT,Tp>

undocumented

Extends: RSetBase.Context<UT,Tp>

Implemented by: OrderedSetContextImpl<UT,Tp>

Type parameters

Name	Constraints	Default	Description
UT			undocumented
Tp	OrderedSetBase.Types	OrderedSetBase.Types	undocumented

Properties

_fixedElementType

undocumented

Definition

readonly _fixedElementType: (element: UT) => never;

Overrides

Context._fixedElementType

_types

undocumented

Definition

readonly _types: Tp;

Overrides

Context._types

listContext

The List context used create Lists to keep value insertion order.

Definition

readonly listContext: List.Context;

setContext

The wrapped Set context type.

Definition

readonly setContext: WithElem<Tp, UT>['sourceContext'];

typeTag

undocumented

Definition

readonly typeTag: 'OrderedSet';

Overrides

Context.typeTag

Methods

builder

Returns an empty builder instance for this type of collection and context.

Definition

builder<T extends UT>(): WithElem<Tp, T>['builder'];

Type parameters

Name	Constraints	Description
T	UT

example

HashSet.builder<number>()     // => HashSet.Builder<number>

Overrides

Factory.builder

empty

Returns the (singleton) empty instance of this type and context with given value type.

Definition

empty<T extends UT>(): WithElem<Tp, T>['normal'];

Type parameters

Name	Constraints	Description
T	UT

example

HashSet.empty<number>()    // => HashSet<number>
HashSet.empty<string>()    // => HashSet<string>

Overrides

Factory.empty

from

Returns an immutable set of this collection type and context, containing the given values in source.

Definitions

from<T extends UT>(...sources: ArrayNonEmpty<StreamSource.NonEmpty<T>>): WithElem<Tp, T>['nonEmpty'];

from<T extends UT>(...sources: ArrayNonEmpty<StreamSource<T>>): WithElem<Tp, T>['normal'];

Type parameters

Name	Constraints	Description
T	UT

Parameters

Name	Type	Description
sources	ArrayNonEmpty<StreamSource.NonEmpty<T>>	an array of StreamSource instances containing values

example

HashSet.from([1, 2, 3], [4, 5])   // => HashSet.NonEmpty<number>

Overrides

Factory.from

isValidValue

Returns true if given value could be a valid value in this Context.

Definition

isValidValue(value: any): value is UT;

Parameters

Name	Type	Description
value	any	the object to check

example

HashSet.defaultContext().isValidValue(1)   // => true

Overrides

Context.isValidValue

of

Returns an immutable set of this type and context, containing the given values.

Definition

of<T extends UT>(...values: ArrayNonEmpty<T>): WithElem<Tp, T>['nonEmpty'];

Type parameters

Name	Constraints	Description
T	UT

Parameters

Name	Type	Description
values	ArrayNonEmpty<T>	a non-empty array of values

example

HashSet.of(1, 2, 3).toArray()   // => [1, 2, 3]

Overrides

Factory.of

reducer

Returns a Reducer that appends received items to an RSet and returns the RSet as a result. When a source is given, the reducer will first create an RSet from the source, and then append elements to it.

Definition

reducer<T extends UT>(source?: StreamSource<T>): Reducer<T, WithElem<Tp, T>['normal']>;

Type parameters

Name	Constraints	Description
T	UT

Parameters

Name	Type	Description
source	StreamSource<T>	(optional) an initial source of elements to append to

example

const someList = SortedSet.of(1, 2, 3);
const result = Stream.range({ start: 20, amount: 5 }).reduce(SortedSet.reducer(someList))
result.toArray()   // => [1, 2, 3, 20, 21, 22, 23, 24]

note

uses an RSet builder under the hood. If the given source is a RSet in the same context, it will directly call .toBuilder().

Overrides

Factory.reducer