The isSupersetOf() method of Set instances takes a set and returns a boolean indicating if all elements of the given set are in this set.
Syntax
isSupersetOf(other)
Parameters
other- : A Set object, or set-like object.
Return value
true if all elements in the other set are also in this set, and false otherwise.
Description
In mathematical notation, superset is defined as:
<math display="block"> <semantics><mrow><mi>A</mi><mo>⊇</mo><mi>B</mi><mo stretchy="false">⇔</mo><mo>∀</mo><mi>x</mi><mo>∊</mo><mi>B</mi><mo>,</mo><mspace width="0.16666666666666666em"></mspace><mi>x</mi><mo>∊</mo><mi>A</mi></mrow><annotation encoding="TeX">A\supseteq B \Leftrightarrow \forall x\in B,,x\in A</annotation></semantics> </math>
And using Venn diagram:
A Venn diagram with two circles. A is a superset of B because B is completely contained in A.
[!NOTE] The superset relationship is not proper superset, which means
isSupersetOf()returnstrueifthisandothercontain the same elements.
isSupersetOf() accepts set-like objects as the other parameter. It requires this to be an actual Set instance, because it directly retrieves the underlying data stored in this without invoking any user code. Then, its behavior depends on the sizes of this and other:
- If there are fewer elements in
thisthanother.size, then it directly returnsfalse. - Otherwise, it iterates over
otherby calling itskeys()method, and if any element inotheris not present inthis, it returnsfalse(and closes thekeys()iterator by calling itsreturn()method). Otherwise, it returnstrue.
Examples
Using isSupersetOf()
The set of even numbers (<20) is a superset of multiples of 4 (<20):
const evens = new Set([2, 4, 6, 8, 10, 12, 14, 16, 18]);
const fours = new Set([4, 8, 12, 16]);
console.log(evens.isSupersetOf(fours)); // true
The set of all odd numbers (<20) is not a superset of prime numbers (<20), because 2 is prime but not odd:
const primes = new Set([2, 3, 5, 7, 11, 13, 17, 19]);
const odds = new Set([3, 5, 7, 9, 11, 13, 15, 17, 19]);
console.log(odds.isSupersetOf(primes)); // false
Equivalent sets are supersets of each other:
const set1 = new Set([1, 2, 3]);
const set2 = new Set([1, 2, 3]);
console.log(set1.isSupersetOf(set2)); // true
console.log(set2.isSupersetOf(set1)); // true
Specifications
Browser compatibility
See also
- Polyfill of
Set.prototype.isSupersetOfincore-js - es-shims polyfill of
Set.prototype.isSupersetOf - Set.prototype.difference()
- Set.prototype.intersection()
- Set.prototype.isDisjointFrom()
- Set.prototype.isSubsetOf()
- Set.prototype.symmetricDifference()
- Set.prototype.union()
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
