Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
cache-base
Advanced tools
Basic object cache with `get`, `set`, `del`, and `has` methods for node.js/javascript projects.
The cache-base npm package is a simple and fast key-value store for caching data. It provides an easy-to-use API for setting, getting, and managing cached data with support for namespaces and custom storage engines.
Setting and getting values
This feature allows users to store and retrieve data by key. The example shows how to set an object with user details and then retrieve it.
{
const Cache = require('cache-base');
const cache = new Cache();
cache.set('user', { name: 'John Doe', age: 30 });
console.log(cache.get('user'));
}
Using namespaces
Namespaces allow for organizing data under a specific context, avoiding key collisions and making data management clearer. The example demonstrates setting and getting data under a 'users' namespace.
{
const Cache = require('cache-base');
const usersCache = new Cache('users');
usersCache.set('user1', { name: 'John Doe', age: 30 });
console.log(usersCache.get('user1'));
}
Custom storage engines
Cache-base supports custom storage engines, allowing users to define how data is stored and retrieved. This example uses JavaScript's Map object as a custom storage engine.
{
const Cache = require('cache-base');
const customStore = new Map();
const cache = new Cache({ store: customStore });
cache.set('key', 'value');
console.log(cache.get('key'));
}
node-cache is another simple caching solution for Node.js. It offers similar functionalities to cache-base but also includes TTL (time to live) support for automatic cache invalidation, which cache-base does not provide by default.
lru-cache is a cache object that deletes the least-recently-used items. It is similar to cache-base in providing a key-value cache but is specifically optimized for scenarios where you need to limit memory usage and manage entries based on usage frequency.
Basic object cache with
get
,set
,del
, andhas
methods for node.js/javascript projects.
Install with npm
$ npm i cache-base --save
var Cache = require('cache-base');
// instantiate
var app = new Cache();
// set values
app.set('a', 'b');
app.set('c.d', 'e');
// get values
app.get('a');
//=> 'b'
app.get('c');
//=> {d: 'e'}
console.log(app.cache);
//=> {a: 'b'}
Inherit
var util = require('util');
var Cache = require('cache-base');
function MyApp() {
Cache.call(this);
}
util.inherits(MyApp, Cache);
var app = new MyApp();
app.set('a', 'b');
app.get('a');
//=> 'b'
Namespace
Define a custom property for storing values.
var Cache = require('cache-base').namespace('data');
var app = new Cache();
app.set('a', 'b');
console.log(app.data);
//=> {a: 'b'}
Create a Cache
constructor that, when instantiated, will store values on the given prop
.
Params
prop
{String}: The property name to use for storing values.returns
{Function}: Returns a custom Cache
constructorExample
var Cache = require('cache-base').namespace('data');
var cache = new Cache();
Create a new Cache
. Internally the Cache
constructor is created using the namespace
function, with cache
defined as the storage object.
Params
cache
{Object}: Optionally pass an object to initialize with.Example
var app = new Cache();
Set property key
with the given value
.
Params
key
{String}value
{any}returns
{Cache}: Returns the instance for chainingExample
app.set('a', 'b');
// or
app.set({a: 'b'});
Return the stored value of key
. If key
is not defined, the cache
is returned.
Params
key
{String}Example
app.set('foo', 'bar');
app.get('foo');
//=> "bar"
Return true if cache key
is not undefined or null.
Params
key
{String}Example
app.set('foo', 'bar');
app.has('foo');
//=> true
Delete one or more properties from the cache.
Params
keys
{String|Array}Example
app.del('foo');
// or
app.del(['foo', 'bar']);
Reset the entire cache to an empty object.
Example
app.clear();
Visit method
, or map-visit method
, over each property in val
.
Params
method
{String}: The name of the method to call.val
{Object|Array}: The object or array to iterate over.Example
app.visit('set', {a: 'b'});
set
, get
,… more | homepage a.b.c
) to get a nested value from an object. | homepage'a.b.c'
) paths. | homepagePull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Install dev dependencies:
$ npm i -d && npm test
Jon Schlinkert
Copyright © 2014-2015 Jon Schlinkert Released under the MIT license.
This file was generated by verb-cli on November 23, 2015.
FAQs
Basic object cache with `get`, `set`, `del`, and `has` methods for node.js/javascript projects.
The npm package cache-base receives a total of 6,482,097 weekly downloads. As such, cache-base popularity was classified as popular.
We found that cache-base demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.