Getting Started

Requirements

• Node.js 24 or later
• pnpm (or npm/yarn)

Installing from GitHub Packages

Packages are published to the GitHub Package Registry under the @studnicky scope. Add the registry to your .npmrc:

@studnicky:registry=https://npm.pkg.github.com

Then install any package:

pnpm add @studnicky/cache

Import runtime code from @studnicky/cache/node or @studnicky/cache/browser; import runtime-neutral schemas and contracts from /entities and /interfaces.

Minimal usage example

import { LruCache } from '@studnicky/cache/node';

const users = LruCache.create<string, { name: string }>({
  capacity: 100,
  ttlMs: 60_000
});

users.set('user-42', { name: 'Ada' });

const user = users.get('user-42');

For browser targets, import the same runtime symbol from @studnicky/cache/browser.

Extending a primitive

Every class exposes documented protected seams. Most are observer hooks for tracing and metrics; some packages also expose behavioral hooks that intentionally transform or redirect control flow. Subclass to add observability without touching the base class:

import { LruCache } from '@studnicky/cache/node';

class InstrumentedCache extends LruCache<string, { name: string }> {
  protected override onHit(key: string, value: { name: string }): void {
    console.log(`[cache] hit key=${key} name=${value.name}`);
  }

  protected override onMiss(key: string): void {
    console.log(`[cache] miss key=${key}`);
  }
}

const cache = InstrumentedCache.create<string, { name: string }>({ capacity: 100 });
cache.get('user-42');

The base LruCache class never logs; observer hooks are no-ops by default. Override only what you need, and check each package page for which hooks are observational versus behavioral.

Next steps

• Architecture: the three design principles in depth
• Packages: the full workspace package index with API examples