A collection of general purpose utility objects for use throughout the neutrium ecosystem of libraries.
The utilities module can be installed using npm as follows:
pnpm install @neutrium/utilities
This package is ESM only and requires Node.js 24 or later. Development uses TypeScript 6.0.3 and pnpm 11.5.0.
Use an ES module import in TypeScript or JavaScript:
import { LruCache, assertPositiveSafeInteger } from "@neutrium/utilities";
const capacity = 128;
assertPositiveSafeInteger(capacity, 'capacity');
const cache = new LruCache<string, number>(capacity);
cache.set('example', 42);
pnpm install
pnpm run verify
The API documentation and feature guides are generated with TypeDoc. Build them locally with pnpm run docs, then open docs/index.html. Generated files are ignored by Git and excluded from the npm package. pnpm run verify runs the package tests and builds the documentation, treating
documentation warnings as errors.
To build and preview the documentation locally:
pnpm run docs:dev
This project is licensed under the MIT License, see the LICENCE file for details.
You are free to:
Under the following conditions:
This plugin is provided "as is", without warranty of any kind. Use at your own risk.