Git Product home page Git Product logo

async-cache's Introduction

async-cache

Cache your async lookups and don't fetch the same thing more than necessary.

Built upon node-lru-cache and forked from async-cache to add a promise api.

Example

const cache = new AsyncCache({
  // options passed directly to the internal lru cache
  max: 1000,
  // in milliseconds
  maxAge: 1000 * 60 * 10,
  // method to load a thing if it's not in the cache.
  // key must be unique in the context of the cache.
  loadFn: async key => fetchData(key),
});

// get a cached key or fetch it
const res = await cache.get('key');

// you can also pass a custom loadFn directly to the get method
const res2 = await cache.get('key', async key => 'data');

Methods

  • async get(key, [async loadFn]) If the key is in the cache, then resolve with value. Else call the provided loadFn. If no loadFn was provided try to use the loadFn that was supplied in the options object. If it doesn't return an error, then cache the result. Multiple get calls with the same key will only ever have a single load call at the same time.

  • set(key, val) Seed the cache. This doesn't have to be done, but can be convenient if you know that something will be fetched soon.

  • reset() Drop all the items in the cache.

async-cache's People

Contributors

brettstimmerman avatar d48 avatar dancalligaro avatar isaacs avatar pirxpilot avatar quentin-sommer avatar tellnes avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.