Overview - Brushy Suite

@brushy/storage provides a NodeCache-style API that runs in Node, the browser, and SSR contexts. Optional persist adapters write to localStorage or sessionStorage, and a built-in invalidation bus keeps tabs in sync when instances share the same id. React bindings live in @brushy/storage-react (separate package).

Install

npm install @brushy/storage

# React hooks (separate package)
npm install @brushy/storage-react react

Quick example

import { createStorage } from "@brushy/storage";

const cache = createStorage({
  id: "my-app",
  stdTTL: 0,
  checkperiod: 600,
  prefix: "@myapp:",
  persist: "local",
});

cache.set("session", { token: "abc" }, 3600);
cache.get("session");
cache.del("session");

Documentation

Getting started

Getting started: install and first instance
Configuration: all StorageOptions
API reference: every Storage method

Features

TTL: duration parsing and expiry
Events: on / off and React subscriptions
Persist adapters: local, session, custom SyncPersist
Cache bus: cross-tab and custom invalidation
Errors: StorageError codes
Node vs browser: SSR, registry, runtime matrix

React & migration

React hooks: StorageProvider, useStorage
Migration from @brushy/localstorage: v1 → v2

Public exports

import {
  createStorage,
  getStorageInstance,
  resetStorageRegistry,
  composeBuses,
  createBroadcastBus,
  getRegistryChannel,
  resetBusRegistry,
  createLocalPersist,
  createSessionPersist,
  createMemoryPersist,
  resolvePersist,
  parseTtlToSeconds,
  expireAtFromTtlSeconds,
  StorageError,
} from "@brushy/storage";