# hashset

> A simple hash set in JavaScript

Latest version **0.0.6** (published 2015-06-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install hashset
pnpm add hashset
yarn add hashset
bun add hashset
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2015-06-20 |
| First published | 2015-06-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/hashset) |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Shuping LIU |
| Maintainers | liushuping |
| Keywords | HashSet, JavaScript, Node |

## Links

- npm: https://www.npmjs.com/package/hashset
- Repository: https://github.com/liushuping/hashset
- Homepage: https://github.com/liushuping/hashset#readme
- Issues: https://github.com/liushuping/hashset/issues
- npm.io page: https://npm.io/package/hashset

## Dependencies (1)

- [string-hash](https://npm.io/package/string-hash.md) ^1.1.0

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.0.6 (latest) — 2015-06-20
- 0.0.5 — 2015-06-19
- 0.0.4 — 2015-06-19
- 0.0.3 — 2015-06-16
- 0.0.2 — 2015-06-16
- 0.0.1 — 2015-06-16
- 0.0.0 — 2015-06-15

## README

HasSet
======
A simple hash set in JavaScript

[![build status](https://travis-ci.org/liushuping/HashSet.svg?branch=master)](https://travis-ci.org/liushuping/HashSet.svg?branch=master)

## Create a new HashSet
```javascript
var HashSet = require('hashset');

//Create an empty hash set
var hashset = new HashSet();

//Create a hash set an initialize it with a value 'a'
var hashset = new HashSet('a');

//Create a hash set an initialize it with a set of values
var hashset = new HashSet('a', 'b', 'c');

//Create a hash set an initialize it with 3 different values
var hashset = new HashSet(1, '1', [1]);
```

## Properties
### length
Get the length of the hash set
```javascript
hashset.length;
```

## Methods
### equals
Test whether current hash set equals to another
```javascript
var hashset1 = new HashSet(1, 2, 3, 4, 5);
var hashset2 = new HashSet(1, 2, 3, 4, 5);
var result = hashset1.equals(hashset2); //true
```

### contains
Check whether a value is in the hash set
```javascript
hashset.contains(val);
```

### add
Add a new value into the hash set
```javascript
hashset.add(val);
```

### remove
Remove a value from the hash set
```javascript
hashset.remove(val);
```
Removing an non-existing value will not trigger any error

### toArray
Convert and output all values into an array
```javascript
var hashset = new HashSet(1, 2, 3);
hashset.toArray();  // [1, 2, 3]
```
There is no gurantee the values of the output array the same sequence as value added to the hash set.

### isSubSetOf
Test whether a hash set is a sub set of another. Empty hash set is a sub set of any other hash set including another empty hash set.
```javascript
var hashset1 = new HashSet();
var hashset2 = new HashSet();
var result = hashset1.isSubSetOf(hashset2);
```
### isSuperSetOf
Test whether a hash set is a super set of another. Any hash set is a super set of empty hahs set including an empty hash set.
```javascript
var hashset1 = new HashSet(1, 2, 3);
var hashset2 = new HashSet(1, 2, 3);
var hashset3 = new HashSet();
var result1 = hashset1.isSuperSetOf(hashset2); //true
var result2 = hashset2.isSuperSetOf(hashset1); //true
var result3 = hashset1.isSuperSetOf(hashset3); //true
var result3 = hashset3.isSuperSetOf(hashset1); //false
```

### unionWith
Union current hash set with another
```javascript
var hashset1 = new HashSet(1, 2);
var hashset2 = new HashSet(2, 3);
hashset1.unionWith(hashset2);
hashset1.contains(1); //true
hashset1.contains(2); //true
hashset1.contains(3); //true
```

### intersectWith
Intersect current hash set with another
```javascript
var hashset1 = new HashSet(1, 2, 3);
var hashset2 = new HashSet(2, 3, 4);
hashset1.intersectWith(hashset2);
hashset1.length; //2
hashset1.contains(2); //true
hashset1.contains(3); //true
hashset1.contains(4); //false
```

## Test
Make sure `mocha` is installed globally
```
npm install mocha -g
```
Run `npm test` to run unit test

## Dependencies

## License
MIT

---
_Source: https://npm.io/package/hashset · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._