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

@autotelic/fastify-swr

v0.2.0

Published

stale-while-revalidate caching handler for fastify

Downloads

12

Readme

Fastify SWR

stale-while-revalidate caching and request de-duplication for fastify

Getting Started

Install

npm i @autotelic/fastify-swr

Usage

const fastifySwr = require('@autotelic/fastify-swr')

async function myClient (path, opts = {}) {
  const res = await fetch(new URL(`https://example.com/${path}`), opts)
  return res.json()
}

async function rootPlugin (fastify, opts) {
  await fastify.register(fastifySwr, { handler: myClient, interval: 10 })

  fastify.get('/', async function routeHandler (request, reply) {
    // By default, the handler's name will be used to name the decorator (see API for mor details)
    const content = await fastify.myClient('/endpoint', {
      headers: {
        accept: 'application/json'
      }
    })
    return content
  })
}

Example App

To run the example app clone this repo locally, npm i, and then run the following

npm run dev

Once running, navigate to localhost:3000 in the browser

API

fastifySwr: FastifyPluginAsync<PluginOpts>

PluginOpts

fastifySwr accepts a PluginOpts object with the following properties:

  • handler: (key: string, ...args: any[]) => any - Required. The function to be wrapped by the plugin. The return value of the handler will be cached using a stale-while-revalidate caching strategy. The handler will be called only when the cache is empty or stale. The wrapped handler is accessible as a decorator on the Fastify instance. By default, the handler's name will be used to name the decorator (ie. fastify.myHandler). A custom decorator name can configured using the name option.

  • interval: number - The interval in seconds used to determine when a cache will be deemed stale. Defaults to 60 seconds.

  • name: string - A custom name for the decorator added by this plugin. By default, the name property of the handler will be used.

  • cache: Pick<Map, 'get' | 'set' | 'delete'> - The cache instance for the plugin to use. Must contain get, set, and delete methods matching the signature of a Map. Method names can be changed using the cacheClientMapping option below. Defaults to new Map().

  • cacheClientMapping: { get: string, set: string, delete: string } - An object used to map custom client method names to the default cache method names. For example, if using a Redis client you would pass in { delete: 'del' }.

  • logger: { debug: (log: string) => void } - A logger to be used for the plugin's debug logs. Defaults to fastify.log (Note: the log-level must be set to 'debug' to view the plugin's logs).