Class HashSet<T>

constructor

• new HashSet<T>(comparer?: HashableEqualityComparer<T>): HashSet<T>

  Type Parameters

  • T

  Parameters

  • Optionalcomparer: HashableEqualityComparer<T>

  Returns HashSet<T>

Readonly[toStringTag]

Readonlycomparer

size

• get size(): number

  Returns number

  the number of (unique) elements in Set.

[iterator]

• "[iterator]"(): SetIterator<T>

  Returns SetIterator<T>

[SetEqualsSymbol]

• "[SetEqualsSymbol]"(other: Iterable<unknown>): boolean

  Parameters

  • other: Iterable<unknown>

  Returns boolean

add

• add(value: T): this

  Appends a new element with a specified value to the end of the Set.

  Parameters

  • value: T

  Returns this

clear

• clear(): void

  Removes all elements from the Set.

  Returns void

delete

• delete(value: T): boolean

  Removes a specified value from the Set.

  Parameters

  • value: T

  Returns boolean

  Returns true if an element in the Set existed and has been removed, or false if the element does not exist.

difference

• difference<U>(other: ReadonlySetLike<U>): Set<T>

  Type Parameters

  • U

  Parameters

  • other: ReadonlySetLike<U>

  Returns Set<T>

  a new Set containing all the elements in this Set which are not also in the argument.

entries

• entries(): SetIterator<[T, T]>

  Returns an iterable of [v,v] pairs for every value v in the set.

  Returns SetIterator<[T, T]>

forEach

• forEach(
      callbackfn: (value: T, value2: T, set: Set<T>) => void,
      thisArg?: unknown,
  ): 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: unknown

  Returns void

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.

intersection

• intersection<U>(other: ReadonlySetLike<U>): Set<T & U>

  Type Parameters

  • U

  Parameters

  • other: ReadonlySetLike<U>

  Returns Set<T & U>

  a new Set containing all the elements which are both in this Set and in the argument.

isDisjointFrom

• isDisjointFrom(
      other: Iterable<unknown, any, any> | ReadonlySetLike<unknown>,
  ): boolean

  Parameters

  • other: Iterable<unknown, any, any> | ReadonlySetLike<unknown>

  Returns boolean

  a boolean indicating whether this Set has no elements in common with the argument.

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.

isSupersetOf

• isSupersetOf(
      other: Iterable<unknown, any, any> | ReadonlySetLike<unknown>,
  ): boolean

  Parameters

  • other: Iterable<unknown, any, any> | ReadonlySetLike<unknown>

  Returns boolean

  a boolean indicating whether all the elements in the argument are also in this Set.

keys

• keys(): SetIterator<T>

  Despite its name, returns an iterable of the values in the set.

  Returns SetIterator<T>

setEquals

• setEquals(other: Iterable<T>): boolean

  Parameters

  • other: Iterable<T>

  Returns boolean

symmetricDifference

• symmetricDifference<U>(
      other: ReadonlySetLike<U> | Iterable<U, any, any>,
  ): Set<T | U>

  Type Parameters

  • U

  Parameters

  • other: ReadonlySetLike<U> | Iterable<U, any, any>

  Returns Set<T | U>

  a new Set containing all the elements which are in either this Set or in the argument, but not in both.

union

• union<U>(other: ReadonlySetLike<U> | Iterable<U, any, any>): Set<T | U>

  Type Parameters

  • U

  Parameters

  • other: ReadonlySetLike<U> | Iterable<U, any, any>

  Returns Set<T | U>

  a new Set containing all the elements in this Set and also all the elements in the argument.

values

• values(): SetIterator<T>

  Returns an iterable of values in the set.

  Returns SetIterator<T>

Staticfrom

• from<T>(
      values?: Iterable<T, any, any> | ReadonlySetLike<T>,
      comparer?: HashableEqualityComparer<T>,
  ): HashSet<T>

  Type Parameters

  • T

  Parameters

  • Optionalvalues: Iterable<T, any, any> | ReadonlySetLike<T>
  • Optionalcomparer: HashableEqualityComparer<T>

  Returns HashSet<T>