Class ObjectSet<T>

Extended implementation of Set, to support objects and custom comparison logic.

See

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set

Type Parameters

T = any

Hierarchy

Set<T>
- ObjectSet

Index

Constructors

Properties

[toStringTag] [species]

Accessors

Methods

[iterator] add clear delete entries equals forEach has keys values

Constructors

constructor

new ObjectSet<T = any>(iterable?: Iterable<T>): ObjectSet<T>
Type Parameters
- T = any
Parameters
- Optionaliterable: Iterable<T>
Returns ObjectSet<T>
Overrides Set<T>.constructor
- Defined in src/object_set.ts:14

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

`Static` `Readonly`[species]

"[species]": SetConstructor

Accessors

size

get size(): number
Returns number
the number of (unique) elements in Set.
Overrides Set.size
- Defined in src/object_set.ts:77

Methods

[iterator]

"[iterator]"(): ArrayIterator<T>
Returns ArrayIterator<T>
Overrides Set.[iterator]
- Defined in src/object_set.ts:59

add

add(item?: T): ObjectSet<T>
Appends a new element with a specified value to the end of the Set.
Parameters
- Optionalitem: T
Returns ObjectSet<T>
Overrides Set.add
- Defined in src/object_set.ts:48

clear

clear(): void
Returns void
Overrides Set.clear
- Defined in src/object_set.ts:55

delete

delete(item: T): boolean
Removes a specified value from the Set.
Parameters
- item: 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/object_set.ts:38

entries

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

Returns SetIterator<[T, T]>
Overrides Set.entries
- Defined in src/object_set.ts:71

equals

equals(a: T, b: T): boolean
Parameters
- a: T
- b: T
Returns boolean
- Defined in src/object_set.ts:25

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
Overrides Set.forEach
- Defined in src/object_set.ts:81

has

has(needle: T): boolean
Parameters
- needle: T
Returns boolean
a boolean indicating whether an element with the specified value exists in the Set or not.
Overrides Set.has
- Defined in src/object_set.ts:29

keys

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

Returns SetIterator<T>
Overrides Set.keys
- Defined in src/object_set.ts:63

values

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

Returns SetIterator<T>
Overrides Set.values
- Defined in src/object_set.ts:67