npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

make-it-cacheable

v0.1.1

Published

Library agnostic caching

Downloads

13

Readme

make-it-cacheable

Library agnostic caching 🥇

Can make the selected methods cached

  • The tool only makes the selected methods cached
  • The cache is invalidated using a custom TTL

Usage

ESM

import makeCacheable from "make-it-cacheable"

CommonJS

const makeCacheable = require("make-it-cacheable");

API

makeCacheable(target, options)

Returns a copy of the target object that the selected methods are cacheable.

  • target (Obj) The object/instance to enhance
  • options (Obj) Configuration
    • ttl (number) The time in milliseconds where a method's result remains cached
    • methods (Array) The methods of the target that will be cacheable
    • debug (boolean) Prints verbose messages in console for debuging

Demos

With Axios

// Axios demo
import makeCacheable from "make-it-cacheable";
import axios from "axios"; // make sure to install axios before trying this demo
(async () => {
  const methods = ["get"]; // select the methods that will be cached
  const ttl = 10000; // set the cache TTL (in milliseconds)
  const debug = true; // optional
  const cachedAxios = makeCacheable(axios, { methods, ttl, debug });
  try {
    const getData = await cachedAxios.get(
      "https://jsonplaceholder.typicode.com/todos/1"
    );
    console.log(getData.data);
    const cachedGetData = await cachedAxios.get(
      "https://jsonplaceholder.typicode.com/todos/1"
    );
    console.log(cachedGetData.data);
  } catch (error) {
    console.log(error);
  }
})();

With a Custom implementation

// CUSTOM Function demo
import makeCacheable from "make-it-cacheable";

(async () => {
  const test = {
    getHello: (msg) => {
      return new Promise((resolve, reject) => {
        setTimeout(() => {
          console.log("NON cached", msg);
          resolve({ message: `Hello ${msg}` });
        }, 3000);
      });
    },
    getRandomNumber: () => {
      console.log("NON cached", "getRandomNumber");
      return Math.random();
    },
    getLatest: (msg) => {
      return new Promise((resolve, reject) => {
        setTimeout(() => {
          console.log("NEVER cached", msg);
          resolve({ message: `Hello ${msg}` });
        }, 500);
      });
    },
  };

  const methods = ["getHello", "getRandomNumber"];
  const ttl = 3000;
  const cacheable = makeCacheable(test, { methods, ttl });

  await Promise.all([
    cacheable.getHello("world"),
    cacheable.getHello("beautiful world"),
  ]);
  console.log(await cacheable.getHello("beautiful world"));
  console.log(await cacheable.getHello("new world"));
  console.log(await cacheable.getHello("world"));
  console.log(await cacheable.getHello("world 2"));
  await Promise.all([
    cacheable.getHello("new world"),
    cacheable.getHello("world"),
  ]);

  // Never cached !!!
  console.log(await cacheable.getLatest("world"));
  console.log(await cacheable.getLatest("world"));
  console.log(await cacheable.getLatest("world"));

  console.log(cacheable.getRandomNumber());
  console.log(cacheable.getRandomNumber());
  console.log(await cacheable.getHello("world is new"));
})();