Registry / database / meshblu-core-cache

meshblu-core-cache

library1.9.1jsnpmunverified

Meshblu cache library for caching Meshblu device data, version 1.9.1. This package provides a simple in-memory cache with TTL support for Meshblu core services. It is part of the Octoblu ecosystem and is used internally by other Meshblu components. The library has low release cadence and minimal dependencies, primarily relying on lodash and redis. It offers basic set/get/del operations and is not intended for general-purpose caching outside of Meshblu.

database

npm install meshblu-core-cache

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · MESHBLU-CORE-CACHE

meshblu-core-cache

databasejavascriptv1.9.1

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.

Cache

✓ import Cache from 'meshblu-core-cache'

✗ const Cache = require('meshblu-core-cache').Cache

Default export is the Cache class

Cache

✓ const Cache = require('meshblu-core-cache')

✗ const { Cache } = require('meshblu-core-cache')

CommonJS default import

CacheConfig

✓ import { CacheConfig } from 'meshblu-core-cache'

✗ import CacheConfig from 'meshblu-core-cache'

Named export for configuration type

Creates a cache instance with Redis backend, then sets, gets, and deletes a key.

import Cache from 'meshblu-core-cache'; const cache = new Cache({ namespace: 'myapp', ttl: 3600, // seconds redis: { host: process.env.REDIS_HOST || 'localhost', port: parseInt(process.env.REDIS_PORT || '6379'), }, }); await cache.set('key', 'value'); const val = await cache.get('key'); console.log(val); // 'value' await cache.del('key'); await cache.close();

Debug

Known issues

gotchaCache constructor requires 'redis' object, but if omitted, it falls back to an in-memory store. This can lead to accidental in-memory usage in production.

fix

Always provide a redis configuration object in production.

affects: >=1.0.0

deprecatedThe 'set' method does not support promises in versions <1.5.0; callbacks are used.

fix

Upgrade to >=1.5.0 for promise support.

affects: <1.5.0

breakingIn v1.9.0, the 'Cache' constructor's 'ttl' option changed from milliseconds to seconds.

fix

Update TTL values from milliseconds to seconds.

affects: >=1.9.0

gotchaThe 'get' method returns 'null' if key not found, not undefined.

fix

Check for null explicitly.

affects: >=1.0.0

gotchaThe 'del' method does not throw if key does not exist; it resolves to undefined.

fix

No need to catch errors for non-existent keys.

affects: >=1.5.0

Errors

Common errors & fixes

TypeError: Cache is not a constructor

Using import incorrectly for CommonJS

fix

Use const Cache = require('meshblu-core-cache');

Error: redis connection refused

Redis host/port not configured correctly

fix

Check REDIS_HOST and REDIS_PORT environment variables or pass correct config.

TypeError: cache.set is not a function

Cache instance not created properly or using wrong import

fix

Ensure you have created an instance: const cache = new Cache(options);

Upgrade

Version history

1.9.1latest on npm

Audit

Dependencies

lodashrequiredutility functions

redisrequiredredis client for cache backend

Agent activity

3 hits · last 30 days

node

Resources

githubhttps://github.com/octoblu/meshblu-core-cache ↗

packagemeshblu-core-cache ↗

homepagehttps://github.com/octoblu/meshblu-core-cache#readme ↗