briznads-helpers

Generic, zero-dependency helper functions and types for use in disparate typescript projects.

install

npm install briznads-helpers --save

use

import { sleep, ago } from 'briznads-helpers';

…

const date : Date = new Date();

async function printString() : void {
	await sleep(2500);

	console.log(`the "date" variable was created ${ ago(date) }`);
}

printString();

background

This package brings together a number of helpful types and functions that I've found myself reaching for time and again. The package exports compiled JavaScript as native ESM modules with TypeScript type declarations, compatible with modern bundlers and supporting tree-shaking.

documentation

Each helper has its own README with usage examples and argument reference.

| Export | Description | | --- | --- | | ago | Format a past date as "X ago". | | deepCopy | JSON-based deep clone. | | flattenEdgeNodeArray | Flatten a GraphQL edges/nodes connection. | | get | Safe nested property access by path. | | getDateString | Date → toString(), '' if invalid. | | getTimeString | Date → toLocaleTimeString(), '' if invalid. | | isEmpty, isEmptyItem, removeEmptyItems | Emptiness checks sharing EmptyOpts. | | isInvalidDate | Test for missing or Invalid Date. | | isListPopulated | Test for non-empty array. | | isNullish | Test for null or undefined. | | lapsed | Format a millisecond duration as human text. | | listify | Ensure a value is an array. | | objectEntries, objectKeys, objectValues | Type-preserving Object.* wrappers. | | parseDate | Normalize a date-like input to Date. | | Query | Regex-based filtering of lists and object arrays. | | roundToDecimals | Round a number to N decimal places. | | sleep | Async delay for N milliseconds. | | smartSort, smartSortFunction | Sort with sensible defaults; comparator exposed. | | sortNumerically | Ascending numeric sort. | | uniqueArray, uniqueFilter | Deduplicate an array; filter callback exposed. |