@ripl/utilities

Shared typed utility functions for Ripl — a unified API for 2D graphics rendering in the browser.

Installation

npm install @ripl/utilities

Overview

A collection of strictly-typed utility functions used across the Ripl ecosystem. Zero dependencies, fully tree-shakable.

API

Type Guards

typeIsArray(value); // value is unknown[]
typeIsFunction(value); // value is AnyFunction
typeIsNil(value); // value is null | undefined
typeIsNumber(value); // value is number
typeIsString(value); // value is string
typeIsObject(value); // value is object
typeIsDate(value); // value is Date
typeIsBoolean(value); // value is boolean

Collection Helpers

arrayJoin(left, right, predicate); // left/inner/right join for data diffing (Map-optimized for key predicates)
arrayMapRange(length, callback); // map over a numeric range
arrayGroup(array, key); // group array items by key or function
arrayIntersection(left, right, predicate); // intersection of two arrays
arrayDifference(left, right, predicate); // difference of two arrays

Note: Generic array wrappers (arrayForEach, arrayMap, arrayFilter, arrayReduce, arrayFind, arrayFlatMap) have been removed in favour of native array methods for better performance.

Object Helpers

objectForEach(object, callback);
objectMap(object, callback);
objectMerge(target, ...sources);

Common Types

OneOrMore<T>; // T | T[]
AnyFunction; // (...args: any[]) => any
AnyObject; // { [key: PropertyKey]: unknown }
Disposable; // { dispose: () => void }
Predicate<L, R>; // (left: L, right: R) => boolean

Value Helpers

valueOr(value, fallback); // value ?? fallback with type narrowing
valueOrDefault(value, fallback); // nullish coalescing with defaults

Documentation

Full documentation is available at ripl.rocks.

License

MIT