Class ElementList

Represents a list of element-like objects. This can be used as a shared memory among Managers so that the consumer has full control at all times.

It is essentially a Set with an O(1) lookup for elements.

Hierarchy

Set<Elemental>
- ElementList

Index

Constructors

constructor

new ElementList(elements?: null | Iterable<Elemental, any, any>): ElementList
Parameters
- Optionalelements: null | Iterable<Elemental, any, any>
Returns ElementList
Overrides Set<Elemental>.constructor
- Defined in src/domain/ElementList.ts:12

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

elements

elements: Elemental[]

`Readonly`size

size: number

Returns

the number of (unique) elements in Set.

`Static` `Readonly`[species]

"[species]": SetConstructor

Methods

[iterator]

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

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

add

add(element: Elemental): ElementList
Appends a new element with a specified value to the end of the Set.
Parameters
- element: Elemental
Returns ElementList
Overrides Set.add
- Defined in src/domain/ElementList.ts:27

asArray

asArray(): Elemental[]
Returns Elemental[]
- Defined in src/domain/ElementList.ts:55

clear

clear(): void
Returns void
Overrides Set.clear
- Defined in src/domain/ElementList.ts:50

delete

delete(element: Elemental): boolean
Removes a specified value from the Set.
Parameters
- element: Elemental
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/domain/ElementList.ts:36

difference

difference(other: ReadonlySetLike): Set<Elemental>
Type Parameters
- U
Parameters
- other: ReadonlySetLike
Returns Set<Elemental>
a new Set containing all the elements in this Set which are not also in the argument.
Inherited from Set.difference
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:48

entries

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

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

forEach

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

get

get(index: number): Elemental
Parameters
- index: number
Returns Elemental
- Defined in src/domain/ElementList.ts:23

has

has(value: Elemental): boolean
Parameters
- value: Elemental
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

intersection

intersection(other: ReadonlySetLike): Set<Elemental & U>
Type Parameters
- U
Parameters
- other: ReadonlySetLike
Returns Set<Elemental & U>
a new Set containing all the elements which are both in this Set and in the argument.
Inherited from Set.intersection
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:44

isDisjointFrom

isDisjointFrom(other: ReadonlySetLike<unknown>): boolean
Parameters
- other: ReadonlySetLike<unknown>
Returns boolean
a boolean indicating whether this Set has no elements in common with the argument.
Inherited from Set.isDisjointFrom
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:64

isSubsetOf

isSubsetOf(other: ReadonlySetLike<unknown>): boolean
Parameters
- other: ReadonlySetLike<unknown>
Returns boolean
a boolean indicating whether all the elements in this Set are also in the argument.
Inherited from Set.isSubsetOf
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:56

isSupersetOf

isSupersetOf(other: ReadonlySetLike<unknown>): boolean
Parameters
- other: ReadonlySetLike<unknown>
Returns boolean
a boolean indicating whether all the elements in the argument are also in this Set.
Inherited from Set.isSupersetOf
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:60

keys

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

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

symmetricDifference

symmetricDifference(other: ReadonlySetLike): Set<Elemental | U>
Type Parameters
- U
Parameters
- other: ReadonlySetLike
Returns Set<Elemental | U>
a new Set containing all the elements which are in either this Set or in the argument, but not in both.
Inherited from Set.symmetricDifference
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:52

union

union(other: ReadonlySetLike): Set<Elemental | U>
Type Parameters
- U
Parameters
- other: ReadonlySetLike
Returns Set<Elemental | U>
a new Set containing all the elements in this Set and also all the elements in the argument.
Inherited from Set.union
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:40

values

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

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

Class ElementList

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ElementList

Properties

Readonly[toStringTag]

elements

Readonlysize

Returns

Static Readonly[species]

Methods

[iterator]

Returns SetIterator<Elemental>

add

Parameters

Returns ElementList

asArray

Returns Elemental[]

clear

Returns void

delete

Parameters

Returns boolean

difference

Type Parameters

Parameters

Returns Set<Elemental>

entries

Returns SetIterator<[Elemental, Elemental]>

forEach

Parameters

Returns void

get

Parameters

Returns Elemental

has

Parameters

Returns boolean

intersection

Type Parameters

Parameters

Returns Set<Elemental & U>

isDisjointFrom

Parameters

Returns boolean

isSubsetOf

Parameters

Returns boolean

isSupersetOf

Parameters

Returns boolean

keys

Returns SetIterator<Elemental>

symmetricDifference

Type Parameters

Parameters

Returns Set<Elemental | U>

union

Type Parameters

Parameters

Returns Set<Elemental | U>

values

Returns SetIterator<Elemental>

Settings

On This Page

`Readonly`[toStringTag]

`Readonly`size

`Static` `Readonly`[species]