Neglected Pizza Money

    simple-storage-cache
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.4 • Public • Published

    Simple Storage Cache npm version

    build and release codecov CodeFactor

    Simple Storage Cache to save API responses and avoid unnecessary requests.

    Dependencies-free and super small.

    install size

    Usage

    Install simple-storage-cache:

    npm install simple-storage-cache
    

    Create an instance with the key that you want to use and the expiration time in milliseconds:

    import Cache from 'simple-storage-cache';
    
    const ONE_MINUTE = 60000;
    const KEY = 'somekey'; 
    const cache = new Cache(KEY, ONE_MINUTE);

    The key will be transformed to use the 'ssc-' prefix: 'ssc-somekey'.

    By default, the module will use localStorage, but you can change the Storage interface to be sessionStorage by explicitly passing it on the constructor:

    const cache = new Cache('somekey', 60000, sessionStorage);

    Methods

    Simple Storage cache provides two convenient methods: get and update.

    get()

    The get() method is used to get the data stored in Storage. It will return null if there is not data to retrieve or if the key has expired.

    If there is data to retrieve and it hasn't expired, then it will return an object with two properties, the data property, containing the data that was originally stored, and the expiration property, with the expiration time as a number of milliseconds.

    const cached = cache.get();
    console.log(cached);
    // { data: { ... }, expiration: 1595179891655, }

    update(data)

    The update(data) method allows to set new data or update it:

    const response = await fetch(url);
    const data = await response.json();
    
    cache.update(data);

    Example

    import Cache from "simple-storage-cache";
    import axios from "axios";
    
    async function getChuckNorrisFact() {
      const ONE_MINUTE = 60000;
      const URL = "https://api.chucknorris.io/jokes/random";
      const cache = new Cache("chuck", ONE_MINUTE);
    
      const cached = cache.get();
    
      if (cached) {
        return cached.data;
      }
    
      const response = await axios.get(url);
    
      cache.update(response.data);
    
      return response.data;
    }

    You can also use it with TypeScript:

    import Cache from "simple-storage-cache";
    import axios, { AxiosResponse } from "axios";
    
    interface ChuckNorrisFact {
      categories: string[];
      created_at: string;
      icon_url: string;
      id: string;
      updated_at: string;
      url: string;
      value: string;
    }
    
    async function getChuckNorrisFact() {
      const ONE_MINUTE = 60000
      const URL = "https://api.chucknorris.io/jokes/random";
      
      const cache = new Cache<ChuckNorrisFact>("chuck", ONE_MINUTE);
      
      const cached = cache.get();
    
      if (cached) {
        return cached.data;
      }
    
      const response = await axios.get<string, AxiosResponse<ChuckNorrisFact>>(url);
    
      cache.update(response.data);
    
      return response.data;
    }

    Acknowledgements

    Some of the best ideas for this module came from an outstanding code review by r3dst0rm.

    Contributing

    Contributions, issues and feature requests are welcome!

    Show your support

    Give a ⭐️ if you like this project!

    License

    MIT.

    Install

    npm i simple-storage-cache

    DownloadsWeekly Downloads

    24

    Version

    1.2.4

    License

    MIT

    Unpacked Size

    8.2 kB

    Total Files

    5

    Last publish

    Collaborators

    • mauriciorobayo