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

@piplup/cache-buster

v3.2.2

Published

React library that helps in busting cache

Downloads

1,190

Readme

@piplup/cache-buster

npm

Cache buster library (<1kb) for React that helps in busting cache by checking changes for a unique release ID and calling window.location.reload when a change is detected in release ID.

Installation

You can install @piplup/cache-buster using:

npm install @piplup/cache-buster

// or

yarn add @piplup/cache-buster

// or

pnpm add @piplup/cache-buster

Usage

  1. Integration with your build process:

    Include a script in your package.json to generate a release ID before building your application:

{
  "scripts": {
    "build": "piplup-cache-buster --publicDir=public && react-scripts build"
  }
}

Alternatively, if you are using vite to build your react application. You can use @piplup/vite-plugin-cache-buster and update your vite configuration file (usually vite.config.js or vite.config.ts) to the following:

import { vitePluginCacheBuster } from '@piplup/vite-plugin-cache-buster';

export default {
  // Other Vite config options...
  plugins: [vitePluginCacheBuster() /*...other plugins */],
};
  1. Integrate CacheBuster into your application:
import { CacheBuster } from '@piplup/cache-buster';

function App() {
  return (
    <>
      <CacheBuster
        loading={null} // Optional: Add a loading component to display loading.
        verbose={false} // Optional: If true, logs will be visible.
        storageKey="RELEASE" // Optional: local storage key for storing the unique release ID.
        enabled={process.env.NODE_ENV === 'production'}
      />
      <YourApp />
    </>
  );
}

export default App;

Props

  • enabled (optional): Boolean indicating whether the cache busting functionality should be enabled. Default is true.
  • loading (optional): React node to be displayed while checking for updates. Default is null.
  • verbose (optional): Boolean indicating whether verbose logging should be enabled. Default is false.
  • storageKey (optional): local storage key for storing the unique release ID. Default is RELEASE
  • children (optional): The child components to render within the cache buster.

How It Works

CacheBuster fetches a release ID from the public folder using a predefined file name. It then compares this ID with the one stored in the browser's local storage. If a new release is detected, it reloads the page. Otherwise, it proceeds to render the child components.

Contributing

Contributions are welcome! Feel free to submit issues or pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.