README.md

Nuxt Cache Module

Cache components and pages on the server

Installation

yarn add @raminjafary/nuxt-cache-module
# or
npm i @raminjafary/nuxt-cache-module

module.exports = {
  buildModules: [
    '@raminjafary/nuxt-cache-module'
  ],
  // Module options
  cache: {
    // Set cache header on response when it hits cache.
    cacheHeader: 'x-cache',
    // Routes to be cached whether string or regexp.
    pages: [
      /^\/$/,
      /\/about/,
      '/todo'
    ],
    // Set time to live
    ttl: 60,
    // Configure Redis
    // All Redis options are supported
    redis: {
      port: 6379,
      host: 'localhost',
    }
  }
}

Component caching is also possible with the cache component. The default TTL is 60 seconds. You can configure ttl in module option. A unique id and timestamp is used as cache key.

<cache :cache="{ id: 'title', lastUpdated: '1601923810954' }">
  <div>
    Hello World!
  <div>
</cache>

Note: you should NOT cache a component when:

• It has child components that may rely on global state.
• It has child components that produces side effects on the render context.
• You don't have user-specific content and you opt for page level caching.

For more information see When to use component caching.

Development

• Clone this repository.
• Install dependencies using yarn install or npm install.
• Start development server using npm run dev or yarn dev.
• Follow the Conventional Commits Specification for opening PRs.

License

MIT