Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

core.io-cache-redis

Package Overview
Dependencies
Maintainers
1
Versions
17
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

core.io-cache-redis

Redis cache module

  • 0.16.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
3
increased by200%
Maintainers
1
Weekly downloads
 
Created
Source

core.io Cache Redis

This package provides a module for the core.io library.

Install

$ npm i -S core.io-cache-redis

Usage

The CacheClient exposes a tryGet function that takes a key, a fallback function and an options object.

  • key: Either a string or an object that will be used to create a cache identification key. If key is not found in the cache we call fallback and store the functions output in cache using key as identifier. Next time we call tryGet we return the cached value.
  • fallback: Some (expensive) function that we want to cache the outputs of its execution.

Options:

  • ttl default(defaultTTL): Time to live for the key after which the key expires.
  • deserialize default(true): Call deserialize on the cached value
  • addTimestamp default(true): Add a time-stamp to the cached value
  • throwOnError default(false): If true any errors while calling fallback will be thrown, else returned in the value
  • forceCacheMiss default(false): Function or boolean to check if we want to force fallback call.
result = await cache.tryGet(query, async _ => {
    return await service.query(query);
});
Key Hashing

We can use strings or objects as the raw source for the cache key. If the raw key is an object will be serialized to a string. Then the create an md5 hash with the key and prepped the cacheKeyPrefix.

By default the serialize and deserialize functions are mapped to JSON.stringify and JSON.parse respectively.

If our raw key is the following object:

const query = { limit: 100, order: 'DESC', where: { id: 23 } };
let key = cache.hashKey(query);
assert(key === 'cache:1239ecd04b073b8f4615d4077be5e263');

License

® License by goliatone

Keywords

FAQs

Package last updated on 07 Dec 2022

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc