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

apollo-cache-persist-compressed

v1.0.0

Published

🗜️ Compressed cache persistence for Apollo Client

Downloads

4

Readme

apollo3-cache-persist-compressed

Exposes wrappers built on top of apollo3-cache-persist, but leverages compression via GZip (powered by fflate) to reduce the size of the stored cache.

Currently, the only wrapper exposed is CompressedLocalForageWrapper, which is a drop-in replacement for LocalForageWrapper from apollo3-cache-persist, but persists the cache in a compressed format. localForage supports all sorts of JavaScript objects, including binary data (Uint8Array), so it's a good choice for persisting compressed data as binary, which saves us from having to convert the compressed binary to a base64 string.

Compressing strings, especially Apollo Client's cache is quite efficient because a cache (even a normalized one) will have a lot of repeated tokens, which can be compressed quite well. The GZip compression is powered by fflate.

Compresses a cache of 1 MB into 60 KB in 22ms 🔥 (Tested on an M1 Pro).

By default, apollo3-cache-persist only persists a stringified version of the cache up to 1,048,576 characters (1 MB), which can be quickly reached with a cache of a few hundred entities. This library allows you to compress the cache before persisting it, which can save a lot of space while ensuring you can leverage the full power of Apollo Client's cache rather than purging the cache every few interactions.

Usage

[!WARNING] apollo3-cache-persist-compressed is meant to be used on top of apollo3-cache-persist, make sure to install both!

npm install --save apollo3-cache-persist apollo3-cache-persist-compressed

or

yarn add apollo3-cache-persist apollo3-cache-persist-compressed

Finally, use CompressedLocalForageWrapper as a drop-in replacement for LocalForageWrapper:

[!CAUTION] The compressed storage doesn't support migrating from a string-based cache. Therefore, it's really important to version your localForage via the name config!

[!IMPORTANT] Ensure the serialize option on persistCache isn't turned off, as the compression expects to receive a serialized version of the cache to compress it as a string. serialize defaults to true.

import { InMemoryCache } from '@apollo/client/core';
import { persistCache } from 'apollo3-cache-persist';
import { CompressedLocalForageWrapper } from 'apollo3-cache-persist-compressed';
import localforage from 'localforage';

const cache = new InMemoryCache({...});

localforage.config({
  driver: localforage.INDEXEDDB,
  name: 'apollo-cache-v2',
});

// await before instantiating ApolloClient, else queries might run before the cache is persisted
await persistCache({
  cache,
  storage: new CompressedLocalForageWrapper(localforage),
  serialize: true,
});

// Continue setting up Apollo as usual.

const client = new ApolloClient({
  cache,
  ...
});

License

merge-drivers is MIT licensed.