is-set

What is is-set?

The `is-set` npm package is designed to provide a simple and efficient way to check if a given value is a Set object. This can be particularly useful when working with collections of unique values and you need to ensure that the data structure being manipulated or checked is indeed a Set.

What are is-set's main functionalities?

Check if a value is a Set

This feature allows you to verify if a given value is an instance of a Set. It is particularly useful when you need to differentiate between Set objects and other iterable or collection types in JavaScript, such as Arrays, Objects, or even WeakSets. The code sample demonstrates how to use `is-set` to check various values, showing that it correctly identifies Set instances and distinguishes them from other types.

"use strict";\nconst isSet = require('is-set');\n\nconsole.log(isSet(new Set())); // true\nconsole.log(isSet(new WeakSet())); // false\nconsole.log(isSet([1, 2, 3])); // false\nconsole.log(isSet({})); // false\nconsole.log(isSet(undefined)); // false"

Other packages similar to is-set

lodash.isset

While `lodash.isset` does not exist as a standalone package, Lodash as a utility library offers functions like `_.isSet` which provide similar functionality to `is-set`. Lodash's `_.isSet` function checks if a value is classified as a Set object. The main difference is that Lodash offers a wide range of utility functions beyond checking for Sets, making it a more comprehensive solution for different types of data manipulations and checks.

is

The `is` package offers a wide range of type-check functions, including checks for Sets. Similar to `is-set`, it can be used to determine if a given value is a Set. However, `is` goes beyond just Sets, offering type checks for a variety of JavaScript data types and structures, making it a more versatile package if you need to perform multiple types of checks.

README

is-set

Is this value a JS Set? This module works cross-realm/iframe, and despite ES6 @@toStringTag.

Example

var isSet = require('is-set');
assert(!isSet(function () {}));
assert(!isSet(null));
assert(!isSet(function* () { yield 42; return Infinity; });
assert(!isSet(Symbol('foo')));
assert(!isSet(1n));
assert(!isSet(Object(1n)));

assert(!isSet(new Map()));
assert(!isSet(new WeakSet()));
assert(!isSet(new WeakMap()));

assert(isSet(new Set()));

class MySet extends Set {}
assert(isSet(new MySet()));

Tests

Simply clone the repo, npm install, and run npm test

Changelog

v2.0.3 - 2024-03-08

Commits

• [actions] reuse common workflows 9d26ac6
• [actions] use node/install instead of node/run; use codecov action 3c91325
• add types 8fcc646
• [Dev Deps] update eslint, @ljharb/eslint-config, object-inspect, safe-publish-latest, tape 91caa24
• [readme] update URLs 130e57b
• [Dev Deps] update eslint, @ljharb/eslint-config, aud, auto-changelog, es5-shim, object-inspect, tape 4d75ee2
• [actions] remove redundant finisher 052fdce
• [Dev Deps] update eslint, @ljharb/eslint-config, auto-changelog, core-js, es5-shim, object-inspect, safe-publish-latest, tape eb31797
• [actions] update rebase action to use reusable workflow 8c478ba
• [actions] update codecov uploader a0dac6b
• [Dev Deps] update @ljharb/eslint-config, aud, es6-shim, object-inspect, tape 28d75a3
• [Dev Deps] update eslint, @ljharb/eslint-config, aud, object-inspect, tape 7b2a4a7
• [Dev Deps] update eslint, @ljharb/eslint-config, es5-shim, tape 20ce047
• [readme] add actions and codecov badges e6e1796
• [meta] add missing engines.node 9ed19af
• [meta] use prepublishOnly script for npm 7+ 618f861
• [readme] remove dead badges 76e890e
• [meta] add sideEffects flag e21859b