Class Set

• Object
  • Set

A Set can store any kind of element and ensures that no duplicates exist. Objects are stored and iterated in insertion order.

API Versioned:

From version 21.2.

Properties

size : Number

Number of elements stored in this set.

Constructor Summary

Set()

Creates an empty Set.

Set(values : Iterable)

If the passed value is null or undefined then an empty set is constructed.

Method Summary

add(object : Object) : Set

Adds an element to the set.

clear() : void

Removes all elements from this set.

delete(object : Object) : boolean

Removes the element from the set.

entries() : ES6Iterator

Returns an iterator containing all elements of this set.

forEach(callback : Function) : void

Runs the provided callback function once for each element present in this set.

forEach(callback : Function, thisObject : Object) : void

Runs the provided callback function once for each element present in this set.

has(object : Object) : boolean

Returns if this set contains the given object.

Methods inherited from class Object

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Constructor Detail

Set

publicSet()

Creates an empty Set.

Set

publicSet(values : Iterable)

If the passed value is null or undefined then an empty set is constructed. Else an iterable object is expected that delivers the initial set entries.

Parameters:

values - The initial set entries.

Method Detail

add

add(object : Object) : Set

Adds an element to the set. Does nothing if the set already contains the element.

Parameters:

object - The object to add.

Returns:

This set object.

clear

clear() : void

Removes all elements from this set.

delete

delete(object : Object) : boolean

Removes the element from the set.

Parameters:

object - The object to be removed.

Returns:

true if the set contained the object that was removed. Else false is returned.

entries

entries() : ES6Iterator

Returns an iterator containing all elements of this set.

forEach

forEach(callback : Function) : void

Runs the provided callback function once for each element present in this set.

Parameters:

callback - The function to call, which is invoked with three arguments: the element (as value), the element (as index), and the Set object being iterated.

forEach

forEach(callback : Function, thisObject : Object) : void

Runs the provided callback function once for each element present in this set.

Parameters:

callback - The function to call, which is invoked with three arguments: the element (as value), the element (as index), and the Set object being iterated.

thisObject - The Object to use as 'this' when executing callback.

has

has(object : Object) : boolean

Returns if this set contains the given object.

Parameters:

object - The object to look for.

Returns:

true if the set contains the object else false is returned.