Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 2.1 KB

README.md

File metadata and controls

53 lines (37 loc) · 2.1 KB

cacheable-fetch: RFC-compliant HTTP Caching for fetch()

cacheable-fetch is a fetch() wrapper with an RFC-compliant HTTP Caching layer, intended for use on the server. It supports Node.js, Bun, and Deno, and isn't intended for use in a serverless environment.

AFAIK Cloudflare workers supports caching when using the fetch() API, and you can override some of the settings.

The following RFCs are supported:

Why do I need this?

Just like browser caching makes websites fast, this does the same thing for your server apps, by following the same cache semantics. It's that simple. If you don't understand what HTTP caching is, maybe one of the videos in my "web performance, http caching, and cdn" series will help you. If you have more questions, feel free to start a discussion

It's only a wrapper over fetch(), when you don't need it, just use the regular fetch(). If you want a middleware to cache your server's response, you can check midas-cache.

Usage

Here's the command install this package using npm:

npx jsr add @pmbanugo/cacheable-fetch

Or any of the following for other package managers:

bunx jsr add @pmbanugo/cacheable-fetch
pnpm dlx jsr add @pmbanugo/cacheable-fetch
yarn dlx jsr add @pmbanugo/cacheable-fetch

You use it just like you would use the web fetch() API.

import { cacheableFetch } from "@pmbanugo/cacheable-fetch";

async function getData() {
  const url = "https://example.org/products.json";
  try {
    const response = await cacheableFetch(url);
    if (!response.ok) {
      throw new Error(`Response status: ${response.status}`);
    }

    const json = await response.json();
    console.log(json);
  } catch (error) {
    console.error(error.message);
  }
}