@zerodep/struct-collection v2.0.11

@zerodep/struct-collection

A factory function that returns an optionally-typed, iterable, Collection data structure instance.

A Collection is like a JavaScript Set with better object comparison (for uniqueness of its members) and a few new methods for comparison and operations between Collections.

Full documentation is available at the zerodep.app page.

Signature

declare const structCollectionFactory: <T = any>(items?: T[]) => Collection<T>;

interface Collection<T> {
  add: (item: T) => void;
  has: () => boolean;
  delete: () => T | undefined;
  clear: () => void;
  size: () => number;
  toArray: () => T[];
  union: (col: Collection<T>) => Collection<T>;
  difference: (col: Collection<T>) => Collection<T>;
  intersection: (col: Collection<T>) => Collection<T>;
  isSubsetOf: (col: Collection<T>) => boolean;
  values: () => IterableIterator<T>;
}

Factory Parameters

The structCollectionFactory function has the following parameters:

• items - an optional array of items with which to populate the collection

Collection Methods

The structCollectionFactory returns an object with the following methods:

• add() - adds an item to the collection (if it doesn't already exist in it)
• has() - checks if an item exists in the collection
• delete() - deletes an item from the collection
• clear() - deletes all items from the collection
• size() - how many items are in the collection
• toArray() - converts the collection to an array suitable for serialization
• union() - merges the current collection with another collection, returns a new collection
• difference() - determines the differences between the current and provided collections, returns a new collection
• intersection() - determines the intersection (overlap) between the current and provided collections, returns a new collection
• isSubsetOf() - determines if the collection is a subset of a provided collection

Examples

// ESM
import { structCollectionFactory } from '@zerodep/struct-collection';

// CJS
const { structCollectionFactory } = require('@zerodep/struct-collection');

Simple Case

const collection = structCollectionFactory();

// add items to the collection
collection.add('a');
collection.add('b');
collection.add('c');

// check collection size
collection.size(); // 3

// check if a collection has an item
collection.has('a'); // true
collection.has('xxxx'); // false

// delete an item from a collection and check if it's there
collection.delete('c');
collection.has('c'); // false

Populate at Creation

const collection = structCollectionFactory(['aa', 'bb', 'cc', 'dd']);

// check collection size
collection.size(); // 4

Export/Serialize a Collection

const collection = structCollectionFactory(['aa', 'bb', 'cc', 'dd']);
collection.push('ee');
collection.push('ff');

// export items
collection.toArray(); // ["aa", "bb", "cc", "dd", "ee", "ff"]

Merge Collections

const collectionA = structCollectionFactory(['aa', 'bb', 'cc']);
const collectionB = structCollectionFactory(['cc', 'dd', 'ee']);

// union returns a new collection
const collectionC = collectionA.union(collectionB);

// the "cc" values were merged
collectionC.size(); // 5

// export items
collectionC.toArray(); // ["aa", "bb", "cc", "dd", "ee"]

Difference Between Collections

const collectionA = structCollectionFactory(['aa', 'bb', 'cc']);
const collectionB = structCollectionFactory(['cc', 'dd', 'ee']);

collectionC = collectionA.difference(collectionB);

// export items
collectionC.toArray(); // ["aa", "bb", "dd", "ee"]

Intersection Between Collections

const collectionA = structCollectionFactory(['aa', 'bb', 'cc']);
const collectionB = structCollectionFactory(['cc', 'dd', 'ee']);

collectionC = collectionA.intersection(collectionB);

// export items
collectionC.toArray(); // ["cc"]

Is Subset

const collectionA = structCollectionFactory(['a', 'b', 'c', 'd', 'e']);
const collectionB = structCollectionFactory(['b', 'c', 'd']);

collectionA.isSubsetOf(collectionB); // false
collectionB.isSubsetOf(collectionA); // true

Adding Duplicate Values

const collectionA = structCollectionFactory(['a', 'b', 'c', 'd', 'e']);
collection.size(); // 5

collection.add('c'); // <-- item already exists, duplicates are ignored
collection.size(); // 5

ZeroDep Advantages

• Zero npm dependencies - completely eliminates all risk of supply-chain attacks, decreases node_modules folder size
• ESM & CJS - supports both ECMAScript modules and common JavaScript exports
• Tree Shakable - built to be fully tree shakable ensuring your packages are the smallest possible size
• Fully Typed - typescript definitions are provided/built-in to every package for a superior developer experience
• Semantically Named - package and method names are easy to grok, remember, use, and read
• Documented - actually useful documentation with examples at zerodep.app
• Intelligently Packaged - multiple npm packages of different sizes available allowing a menu or a-la-carte composition of capabilities
• 100% Tested - all methods and packages are fully unit tested
• Predictably Versioned - semantically versioned for peace-of-mind upgrading, valuable changelogs for understand changes
• MIT Licensed - permissively licensed for maximum usability