Registry / storage / exframe-cache-manager

exframe-cache-manager

library2.2.2jsnpmunverified

exframe-cache-manager is a cache management library for the Exframe framework, version 2.2.2. It provides a unified API for managing caching layers (e.g., in-memory, Redis) with features like TTL, invalidation, and multi-tier support. Release cadence is irregular, tied to Exframework releases. Key differentiators include deep integration with exframe-health and exframe-logger for observability. Requires exframe-service for lifecycle management. Exclusive to Node.js; no browser support.

storage devops

npm install exframe-cache-manager

package ↗homepage ↗

INSTALL

IMPORT

SIG · EXFRAME-CACHE-MANA

exframe-cache-manager

storagejavascriptv2.2.2

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

CacheManager

✓ import { CacheManager } from 'exframe-cache-manager'

✗ const { CacheManager } = require('exframe-cache-manager')

ESM-only since v2. No CommonJS support. Named export.

CacheManager

✓ import CacheManager from 'exframe-cache-manager'

✗ import { CacheManager } from 'exframe-cache-manager'

Default export is also available in v2.2+ for convenience, but named is preferred for tree-shaking.

createCache

✓ import { createCache } from 'exframe-cache-manager'

✗ import { createCache } from 'exframe-cache-manager/src'

Factory function; don't import from subpaths. Available since v2.0.

Demonstrates setting up a CacheManager instance with in-memory cache, dependency injection via exframe-service, and basic set/get operations.

import { CacheManager, createCache } from 'exframe-cache-manager'; import { Service } from 'exframe-service'; import { Logger } from 'exframe-logger'; import { HealthCheck } from 'exframe-health'; const logger = new Logger(); const health = new HealthCheck(); const service = new Service('my-service', { logger, health }); const cache = createCache({ type: 'memory', ttl: 300, max: 1000 }); const manager = new CacheManager(service, { cache }); await manager.set('key', { data: 'value' }); const result = await manager.get('key'); console.log(result); // { data: 'value' } await service.start();

Debug

Known issues

breakingVersion 2.0 dropped CommonJS support. All imports must use ESM.

fix

Convert require() to import. Ensure 'type': 'module' in package.json or use .mjs extension.

affects: >=2.0.0

breakingRemoved 'driver' option; use 'type' instead in createCache config.

fix

Replace { driver: 'redis' } with { type: 'redis' }.

affects: >=2.0.0

deprecatedCacheManager constructor no longer accepts a raw adapter object; must use service container.

fix

Wrap adapter with Service: new CacheManager(service, { cache: adapter }).

affects: >=1.5.0 <2.0.0

gotchaThe default export is an object with CacheManager and createCache; cannot import named as default in older v2.

fix

Use named import: import { CacheManager } from 'exframe-cache-manager'.

affects: >=2.0.0 <2.2.0

Errors

Common errors & fixes

Error: Cannot find module 'exframe-cache-manager'

Package not installed or not in node_modules.

fix

Run npm install exframe-cache-manager @exframe/health @exframe/logger @exframe/service (peer deps required).

TypeError: (0 , _exframeCacheManager.createCache) is not a function

Wrong import style — using default import for named export.

fix

Use named import: import { createCache } from 'exframe-cache-manager'.

Error: Service must be an instance of exframe-service

CacheManager constructor expects a Service object, not an adapter directly.

fix

Create a Service instance first: const service = new Service('name', { logger, health }); const manager = new CacheManager(service, { cache }).

Upgrade

Version history

2.2.2latest on npm

Audit

Dependencies

exframe-healthrequiredRequired for health check and monitoring integration

exframe-loggerrequiredRequired for structured logging within cache operations

exframe-servicerequiredRequired for service lifecycle and dependency injection

Agent activity

16 hits · last 30 days

node

Resources

packageexframe-cache-manager ↗

homepagehttps://bitbucket.org/exzeo-usa/exframe#readme ↗