/cache

🔋 Browser and Server Cache module for Nuxt 3

Primary LanguageTypeScriptMIT LicenseMIT

@nuxt-modules/cache

[DEPRECATED] @nuxt-modules/cache

As of Nuxt 3.rc-12 you can use routeRoules so this module is now deprecated. Please use official Nuxt approach

npm version npm downloads Github Actions CI Codecov License

Browser and Server Cache module for Nuxt 3

Features

  • Nuxt 3 ready
  • Easy Browser Cache Control middleware
  • Powerful Server Cache with Redis, memcached, etc [Coming soon]
  • TypeScript support

📖  Read the documentation

Setup

yarn add @nuxt-modules/cache # yarn
npm i @nuxt-modules/cache # npm

Basic usage

Firstly, you need to add @nuxt-modules/cache to your Nuxt config.

// nuxt.config.js

{
  buildModules: [
    [
      '@nuxt-modules/cache',
      {
        browser: {
          pages: [
            ['/', { 'max-age': 3600, 'stale-when-revalidate': 10 }],
            ['/product', { 'max-age': 3600, 'stale-when-revalidate': 10 }],
            ['/category', { 'max-age': 3600, 'stale-when-revalidate': 10 }]
          ]
        }
      }
    ]
  ]
}

And that's it! The module is registered and now your pages will have cache-control headers applied.

@nuxt-modules/cache

For more configuration options, please visit the docs

Configuration of server cache will be added in the next versions.

Development

  1. Clone this repository
  2. Install dependencies using yarn install or npm install
  3. Start development server using yarn dev or npm run dev

License

MIT License