cajache v2.0.2

cajache is a minimalistic javascript caching library.

• ⚡ Optimizes your projects reducing the number of HTTP request or heavy actions performed.
• 🚀 Lightweight.
• ⚪️ Zero dependencies.

Table of contents

• Table of contents
• Import
• Quick start
• Creating a new instance
• Instance options
• Use cases
  • Cache HTTP requests
  • Cache paginated HTTP requests
• API
  • .use
  • .get
  • .set
  • .delete
  • .deleteAll
  • .setConfig
  • TTL watcher
• Go to top

Import

const cajache = require("cajache");

Quick start

Permanent cache

const myFetchFnc = axios.get("https://your.api/resource");

const response = await cajache.use(
    "cache_id_01",
    myFetchFnc
);
// The first time it will execute myFetchFnc.

const cachedResponse = await cajache.use(
    "cache_id_01",
    myFetchFnc
);
// The second time it will return cached value instead re-executing myFetchFnc.

Temporal cache

const myFetchFnc = axios.get("https://your.api/resource");

const response = await cajache.use(
    "cache_id_01",
    myFetchFnc,
    {
        ttl: 1000, // 1 second
    }
);
// The first time it will execute myFetchFnc.

// Sleep 3
await new Promise(res => setTimeout(res, 3000));

const nonCachedResponse = await cajache.use(
    "cache_id_01",
    myFetchFnc,
    {
        ttl: 1000, // 1 second
    }
);
// The second time it will NOT return cached value because it's expired.

Creating a new instance

const cajache = require("cajache");
const myInstance = cajache.new();

Instance options

const cajache = cajache(options);

Use cases

Cache HTTP requests

// fetch 1: 248.659ms
// fetch 2 (cached): 0.015ms
// fetch 3 (cached): 0.008ms


console.time("fetch 1");

let characters = await cajache.use(
    "characters",
    () => axios.get("https://rickandmortyapi.com/api/character/14"),
);

console.timeEnd("fetch 1");
console.time("fetch 2 (cached)");

characters = await cajache.use(
    "characters",
    () => axios.get("https://rickandmortyapi.com/api/character/14"),
);

console.timeEnd("fetch 2 (cached)");



console.time("fetch 3 (cached)");
await cajache.use(
    "characters",
    () => axios.get("https://rickandmortyapi.com/api/character/14"),
);
console.timeEnd("fetch 3 (cached)");

Cache paginated HTTP requests

// fetch page 1: 284.629ms
// fetch page 2: 208.210ms
// fetch page 1 (cached): 0.018ms
// fetch page 2 (cached): 0.008ms


console.time("fetch page 1");

let characters_page1 = await cajache.use(
    ["characters", "page_1"],
    () => axios.get("https://rickandmortyapi.com/api/character/?page=1"),
);

console.timeEnd("fetch page 1");
console.time("fetch page 2");

let characters_page2 = await cajache.use(
    ["characters", "page_2"],
    () => axios.get("https://rickandmortyapi.com/api/character/?page=2"),
);

console.timeEnd("fetch page 2");



console.time("fetch page 1 (cached)");

characters_page1 = await cajache.use(
    ["characters", "page_1"],
    () => axios.get("https://rickandmortyapi.com/api/character/?page=1"),
);

console.timeEnd("fetch page 1 (cached)");
console.time("fetch page 2 (cached)");

characters_page2 = await cajache.use(
    ["characters", "page_2"],
    () => axios.get("https://rickandmortyapi.com/api/character/?page=2"),
);

console.timeEnd("fetch page 2 (cached)");

API

.use

Syntax:

const cachedResponse: Promise = cajache.use(
    id: "myId",
    fetchFnc: () => stuff,
    options: {},
);

Example:

// Simple id
const response = await cajache.use(
    "characters",
    () => axios.get("https://you.api.com/characters"),
);

// Nested id
const response = await cajache.use(
    ["location_2",  "characters", "page_3"],
    () => axios.get("https://you.api.com/location2/characters?page=3"),
);

Example with expire:

const response = await cajache.use(
    ["location_2", "characters", "page_3"],
    () => axios.get("https://you.api.com/location2/characters?page=3"),
    {
        expire: 1000 * 30, // 30 seconds
    }
);

Example with path:

const response = await cajache.use(
    ["location_2", "characters", "page_3"],
    () => axios.get("https://you.api.com/location2/characters?page=3"),
    {
        path: "character.name",
    }
);

Example with condition:

const response = await cajache.use(
    ["location_2", "characters", "page_3"],
    () => axios.get("https://you.api.com/location2/characters?page=3"),
    {
        condition: apiRes => apiRes.isError === false,
    }
);

.get

Syntax:

cajache.get(id);

Or...

const location2_characters_page3 = cajache.get(["location_2", "characters", "page_3"]);

.set

Syntax:

cajache.set(id, value );

Examples:

cajache.set("characters", {...} );

Or...

cajache.set(["location_2", "characters", "page_3"], {...} );

.delete

Syntax;

cajache.delete(id);

Delete location_2 cache entry (and his childrens):

cajache.delete("location_2");

Delete location_2.characters.page_3 cache entry (and his childrens):

.deleteAll

Deletes all cache entries of the instance.

cajache.deleteAll();

.setConfig

Sets the instance config.

cajache.setConfig(key, value);

Keys and values are the same as instance options.

Example:

cajache.setConfig("checkInterval", 1000 * 60 * 5); // 5 minutes

TTL watcher

• It starts automatically when you create any instance.
• It will only iterate over all cache entries with TTL.
• It will delete all expired cache entries every config.checkInterval milliseconds.
• It will check the instance config (config?.checkInterval) after each iteration to stop or continue the loop.
• If the checkInterval is changed it will not not be effective until the next iteration.

Go to top