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

@mapado/swr-promise

v1.2.0

Published

swr-promise is a utility that caches promise results with configurable expiration, error tolerance, and garbage collection to enhance performance and manage cache behavior.

Downloads

19

Readme

swr-promise

NPM version NPM downloads

Install

$ npm install swr-promise

Usage

import swrPromise from "swr-promise";

const fetchData = (url: string) => fetch(url);

const fiveMinute  = 5 * 60 * 1000

const fetchDataSWR = swrPromise(fetchData,{ maxAge: fiveMinute });

fetchDataSWR("https://api.example.com/data")
  .then(console.log)
  .catch(console.error);

API

swrPromise(promiseFn, [options])

Parameters

  • promiseFn: The Promise function to be wrapped.
  • options(optional): An options object with the following properties:
    • maxAge: Cache validity period (ms), default is 0, when it is Infinity, it is cached permanently
    • swr: Cache expiration tolerance time (ms), default Infinity (stale-while-revalidate)
    • sie: Update error tolerance time (ms), default is Infinity (stale-if-error)
    • gcThrottle: Garbage collection throttling time (ms), the default is 0, when it is 0, no garbage collection is performed
    • cacheFulfilled: Whether to cache the current normal result, the default is true (arguments, value) => boolean
    • cacheRejected: Whether to cache the current exception result, the default is false (arguments, error) => boolean
    • argsEqual(optional): Compares the two argument arrays for equality to ensure correct matching and lookup of cache entries in the cache
    • storeCreator(optional): creates a Map to store cached data, but you can use other media such as SQlite by passing a custom storeCreator function

Returns

  • A new function that accepts the same arguments as promiseFn and returns a Promise.

Example

import swrPromise from "swr-promise";

const mock = () =>
  new Promise((resolve) => setTimeout(() => resolve(Math.random()), 1000));

const swrMock = swrPromise(mock, { maxAge: 1000, swr: 1000 });

await swrMock().then(console.log); // 0.9504613827463109
await swrMock().then(console.log); // 0.9504613827463109 same response

// simulate waiting for 1 second
await sleep(1000);

await swrMock().then(console.log); // 0.9504613827463109 same response, but mock function re-executes

LICENSE

This project is licensed under the MIT License.

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

Acknowledgements

This utility function uses:

  • concur-promise to prevents duplicate execution of identical Promise calls
  • lodash.isequal to compare the arguments
  • lodash.throttle to limit the frequency of garbage collection operations.