Giter VIP home page Giter VIP logo

memo-swr's Introduction

memo-swr - Memoization with Stale-While-Revalidate and Enhanced Customization

This module provides two memoization functions, memoSwr and memoSwrExtra, that leverage the Stale-While-Revalidate caching strategy for asynchronous functions. The memoSwr function provides basic memoization capabilities, while memoSwrExtra enhances the memoization with support for custom cache creation and key generation functions.

Features

  • Memoizes the results of asynchronous functions with a Time-To-Live (TTL)
  • Automatically updates the cache in the background after the TTL has expired
  • Uses Stale-While-Revalidate strategy to serve stale data while updating the cache
  • Custom cache implementation support (memoSwr)
  • Supports custom cache creation functions and key generation functions (memoSwrExtra)
  • Integrates with cache-manager for flexible caching options (memoSwrExtra)

Usage

Both functions have similar usage patterns, with memoSwrExtra offering additional options for customization.

Importing the module

import { memoSwr, memoSwrExtra } from './memo-swr';

Using the memoSwr or memoSwrExtra function

// Async function to memoize
async function fetchData(url: string): Promise<any> {
  const response = await fetch(url);
  return response.json();
}

// Memoize options
const options = {
  ttl: 60000, // Time-To-Live in milliseconds
};

// Create a memoized version of fetchData using memoSwr
const memoizedFetchData = memoSwr(fetchData, options);

// or using memoSwrExtra with additional customization
const memoizedFetchDataExtra = await memoSwrExtra(fetchData, {
  ...options,
  createCache: createCustomCache,
  keyGenerator: customKeyGenerator,
});

// Usage of memoized function
(async () => {
  const data = await memoizedFetchData('https://api.example.com/data');
  console.log(data);
})();

Refer to the previous responses for detailed documentation on how to use memoSwr and memoSwrExtra, as well as implementing custom cache creation and key generation functions.

memo-swr's People

Contributors

k-kit 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.