Class FluentSet<T>

Type Parameters

Hierarchy

Set<T>
- FluentSet

Implements

SerializableToJSON<T[]>

Index

Methods

[iterator] add clear combine delete entries forEach has hasAll hasAny keys map remove toArray toJSON values fromArrays fromFluentSets fromValues

Constructors

constructor

new FluentSet<T>(values?: null | readonly T[]): FluentSet<T>
Type Parameters
- T
Parameters
- Optionalvalues: null | readonly T[]
Returns FluentSet<T>
Inherited from Set<T>.constructor
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:116
new FluentSet<T>(iterable?: null | Iterable<T, any, any>): FluentSet<T>
Type Parameters
- T
Parameters
- Optionaliterable: null | Iterable<T, any, any>
Returns FluentSet<T>
Inherited from Set<T>.constructor
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:116

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

`Readonly`size

size: number

Returns

the number of (unique) elements in Set.

`Static` `Readonly`[species]

"[species]": SetConstructor

Methods

[iterator]

"[iterator]"(): SetIterator<T>
Iterates over values in the set.

Returns SetIterator<T>
Inherited from Set.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:198

add

add(...values: T[]): FluentSet<T>
Appends a new element with a specified value to the end of the Set.
Parameters
- ...values: T[]
Returns FluentSet<T>
Overrides Set.add
- Defined in src/framework/typescript/collections/FluentSet.ts:23

clear

clear(): void
Returns void
Inherited from Set.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:95

combine

combine(...sets: FluentSet<T>[]): FluentSet<T>
Parameters
- ...sets: FluentSet<T>[]
Returns FluentSet<T>
- Defined in src/framework/typescript/collections/FluentSet.ts:74

delete

delete(...values: T[]): boolean
Removes a specified value from the Set.
Parameters
- ...values: T[]
Returns boolean
Returns true if an element in the Set existed and has been removed, or false if the element does not exist.
Overrides Set.delete
- Defined in src/framework/typescript/collections/FluentSet.ts:31

entries

entries(): SetIterator<[T, T]>
Returns an iterable of [v,v] pairs for every value v in the set.

Returns SetIterator<[T, T]>
Inherited from Set.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:203

forEach

forEach(
callbackfn: (value: T, value2: T, set: Set<T>) => void,
thisArg?: any,
): void
Executes a provided function once per each value in the Set object, in insertion order.
Parameters
- callbackfn: (value: T, value2: T, set: Set<T>) => void
- OptionalthisArg: any
Returns void
Inherited from Set.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:104

has

has(value: T): boolean
Parameters
- value: T
Returns boolean
a boolean indicating whether an element with the specified value exists in the Set or not.
Inherited from Set.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:108

hasAll

hasAll(...values: T[]): boolean
Parameters
- ...values: T[]
Returns boolean
- Defined in src/framework/typescript/collections/FluentSet.ts:54

hasAny

hasAny(...values: T[]): boolean
Parameters
- ...values: T[]
Returns boolean
- Defined in src/framework/typescript/collections/FluentSet.ts:64

keys

keys(): SetIterator<T>
Despite its name, returns an iterable of the values in the set.

Returns SetIterator<T>
Inherited from Set.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:208

map

map<U>(
callback: (value: T, index: number, set: FluentSet<T>) => U,
): FluentSet<U>
Type Parameters
- U
Parameters
- callback: (value: T, index: number, set: FluentSet<T>) => U
Returns FluentSet<U>
- Defined in src/framework/typescript/collections/FluentSet.ts:116

values

values(): SetIterator<T>
Returns an iterable of values in the set.

Returns SetIterator<T>
Inherited from Set.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:213

`Static`fromArrays

fromArrays<T>(...values: (undefined | null | T[])[]): FluentSet<T>
Type Parameters
- T
Parameters
- ...values: (undefined | null | T[])[]
Returns FluentSet<T>
- Defined in src/framework/typescript/collections/FluentSet.ts:94

`Static`fromFluentSets

fromFluentSets<T>(...values: (undefined | null | FluentSet<T>)[]): FluentSet<T>
Type Parameters
- T
Parameters
- ...values: (undefined | null | FluentSet<T>)[]
Returns FluentSet<T>
- Defined in src/framework/typescript/collections/FluentSet.ts:108

`Static`fromValues

fromValues<T>(...values: T[]): FluentSet<T>
Type Parameters
- T
Parameters
- ...values: T[]
Returns FluentSet<T>
- Defined in src/framework/typescript/collections/FluentSet.ts:84

Class FluentSet<T>

Type Parameters

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns FluentSet<T>

Type Parameters

Parameters

Returns FluentSet<T>

Properties

Readonly[toStringTag]

Readonlysize

Returns

Static Readonly[species]

Methods

[iterator]

Returns SetIterator<T>

add

Parameters

Returns FluentSet<T>

clear

Returns void

combine

Parameters

Returns FluentSet<T>

delete

Parameters

Returns boolean

entries

Returns SetIterator<[T, T]>

forEach

Parameters

Returns void

has

Parameters

Returns boolean

hasAll

Parameters

Returns boolean

hasAny

Parameters

Returns boolean

keys

Returns SetIterator<T>

map

Type Parameters

Parameters

Returns FluentSet<U>

remove

Parameters

Returns FluentSet<T>

toArray

Returns T[]

toJSON

Returns T[]

values

Returns SetIterator<T>

StaticfromArrays

Type Parameters

Parameters

Returns FluentSet<T>

StaticfromFluentSets

Type Parameters

Parameters

Returns FluentSet<T>

StaticfromValues

Type Parameters

Parameters

Returns FluentSet<T>

Settings

On This Page

`Readonly`[toStringTag]

`Readonly`size

`Static` `Readonly`[species]

`Static`fromArrays

`Static`fromFluentSets

`Static`fromValues