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

next-cache-explorer

v1.0.0

Published

Navigate & debug the Next.js data cache

Downloads

5

Readme

NPM MIT License CI/CD Coverage Status

Installation

  1. Install the dependency:

Note: requires Next.js 13.4+ with the app router.

pnpm add next-cache-explorer
yarn add next-cache-explorer
npm i next-cache-explorer
  1. Add the following file to your Next.js app:
// src/app/cache-explorer/[[...slug]]/page.tsx

import { mountCacheExplorer } from 'next-cache-explorer'

export const dynamic = 'force-dynamic'

export default mountCacheExplorer()
  1. Start your app and navigate to the /cache-explorer page.

Usage

Index page

Shows a list of all cache entries and tags. Click an entry to see its details, or a tag to only show entries with that tag.

Tags page

Shows a list of all entries for a given tag.

Entry page

Shows the details of a given cache entry, including:

  • Size in bytes
  • Associated URL
  • Revalidation time / TTL
  • Tags to invalidate this entry
  • Response headers
  • Response body

Options

Mount path

You can choose to place the cache explorer at a different path. The main page will still need to be under [[...slug]]/page.tsx, but if you place it in another base path, you'll need to configure it:

// src/app/admin/cache-explorer/[[...slug]]/page.tsx

export default mountCacheExplorer({
  mountPath: '/admin/cache-explorer',
})

Running in production

By default, the cache explorer will only be available in development mode. To enable it in production, you can set the CACHE_EXPLORER environment variable to true.

You can also enable it programmatically:

export default mountCacheExplorer({
  enabled: true,
})

When disabled, the page (and sub-pages) will render a "Cache explorer is disabled" message.

To redirect to the default NotFound page, use the notFoundWhenDisabled option:

export default mountCacheExplorer({
  notFoundWhenDisabled: true,
})

License

MIT - Made with ❤️ by François Best

Using this package at work ? Sponsor me to help with support and maintenance.

This package is signed with sceau, under the following associated public key:

sceau verify --publicKey 380db0ad0ccf92c3bcffc065b614515dd260cf291ed301a9f6ae550f6419f3c7