set-tools
What is it?
set-tools
is a prototype extension module for beefing up JavaScript's Set
type to include all of your favorite set operations, including difference
, union
, intersection
, issubset
, issuperset
, and toArray
.
What else?
This module is a bit naughty. Normally you are not supposed to extend global JavaScript prototypes. This is because it affects any and all other modules you have loaded. Having said that, these operations are useful and will hopefully be introduced one day as native methods on Set
. Assuming no other module is requiring Set
to have different implementations of these methods or for some reason requiring them not to be there, then this module won't harm anything.
Installation
npm install set-tools --save
Usage
; // requiring it supercharges Set prototype automatically. var s cmp results; /** * intersection */s = 1 3 5 7 9;cmp = 2 3 8 9;results = s; // Set {3, 9} /** * union */s = 1 3 5 7 9;cmp = 2 3 8 9;results = s; // Set {2, 3, 8, 9, 1, 5, 7} /** * difference */s = 1 3 5 7 9;cmp = 2 3 8 9;results = s; // Set {1, 5, 7} /** * issubset */s = 1 3 5 7 9;cmp = 3 5;results = s; // true s = 1 3 5 7 9;cmp = 3 8;results = s; // false /** * issuperset */s = 11 15 18 20;cmp = 11 15 18 20 25 89 100;results = s; // true s = 11 15 18 57 62;cmp = 11 15 18 20 25 89 100;results = s; // false
Contributing
Pull requests are much appreciated and accepted.
License
Released under the MIT License