smart-set v0.0.3
smart-set
SmartSet is a micro-library around set data structure with key arguments.
Install
npm install smart-set
yarn add smart-set
Import package to the project
TypeScript
import { SmartSet } from "smart-set";
JavaScript/Node
let { SmartSet } = require("smart-set");
Usage
The SmartSet
class extends the Set
class, so every member of Set
is available.
Constructor
SmartSet
has two template paramters:
T
is the type of itemsID
is the type of the key (must be primitive)
SmartSet
constructor requires a function that determines the id of an item which should be unique and primitive. The second parameter is a list of items of T
, which will be the starting data of the set. These items will be unique in the set.
import { SmartSet } from "smart-set";
interface Data { id: string };
const mySet = new SmartSet<Data, string>(item => item.id, [{ id: 'id1' }, { id: 'id2' }, { id: 'id1' }]);
Addition
The add(item: T)
and addAll(items: T[])
functions add item(s) to the set uniquely by the given id function.
mySet.add({ id: 'id3' });
mySet.add({ id: 'id1' });
mySet.addAll([{ id: 'id1' }, { id: 'id4' }, { id: 'id5' }]);
Deletion
The delete(item: T)
and deleteId(id: ID)
functions delete an item by the given id function.
The clear()
function deletes all elements.
mySet.delete({ id: 'id3' });
mySet.deleteId('id1');
mySet.clear();
Containment
The has(item: T): boolean
and hasId(id: ID): boolean
check whether an item is part of the set by the given id function.
mySet.has({ id: 'id3' }) === false;
mySet.hasId('id1') === true;
Iteration
SmartSet
is iterable and has the keys(): IterableIterator<ID>
, values(): IterableIterator<T>
and entries(): IterableIterator<[ID, T]>
functions for iterating the set. Keys are the values of the ID
type.
const mySet = new SmartSet<Data, string>(item => item.id, [{ id: 'id1' }, { id: 'id2' }, { id: 'id3' }]);
[...mySet.keys()] === ['id1', 'id2', 'id3'];
[...mySet.values()] === [{ id: 'id1' }, { id: 'id2' }, { id: 'id3' }];
[...mySet.entries()] === [['id1', { id: 'id1' }], ['id2', { id: 'id2' }], ['id3', { id: 'id3' }]];
[...mySet] === [{ id: 'id1' }, { id: 'id2' }, { id: 'id3' }];
mySet.forEach((value, key, set) => { /* something with the key, value and set */ })
Debugging
npm run build
- Build typescript files
npm run test
- Run Jest tests
npm run coverage
- Run code coverage
Rights and Agreements
License MIT