Skip to content

Defining Default Values for Route Cache / CDN ​

You may have noticed that there is no way to provide "default cacheability" via configuration. This is because the module does not cache anything by default.

However, there are several ways to define default cacheability, depending on the use case. They all work per request.

Using a global cache key prefix ​

It's possible to prefix all cache keys automatically with a static or dynamic key using the cacheKeyPrefix option.

Route Cache ​

For Nuxt Pages ​

If you want to cache all Nuxt pages by default you can use the useRouteCache composable in your app.vue, which will be executed for every page.

vue
<template>
  <div class="app">
    <NuxtLayout>
      <NuxtPage />
    </NuxtLayout>
  </div>
</template>

<script lang="ts" setup>
useRouteCache((helper) => {
  helper.setCacheable().setMaxAge(604800)
})
</script>

For any route ​

If you additionally want to include custom API routes, you can define a server middleware:

typescript
export default defineEventHandler((event) => {
  // Cache all routes for 7 days.
  useRouteCache((helper) => {
    helper.setCacheable().setMaxAge(604800)
  }, event)
})

This will be executed for every request, including Nuxt pages and server routes. Only responses to GET and HEAD requests are cached, and Nuxt's build assets, the error page and the module's API are never cached. Make sure that no other route that returns user-specific data is marked as cacheable this way: Call setUncacheable() in these routes, or exclude such paths in the middleware or using the applies server option. Calling setUncacheable() is more robust, since a path check also has to match every other spelling of the path, such as /CHECKOUT for /checkout.

Component Cache ​

The default values for the props of the <RenderCacheable> component are falsy. If you need to vary the cache key based on global things like current language, domain, currency, etc., you can create your own wrapper component:

vue
<template>
  <RenderCacheable :cache-key="cacheKey">
    <slot></slot>
  </RenderCacheable>
</template>

<script lang="ts" setup>
const store = useStore()

const cacheKey = computed(() => {
  return [store.language, store.currency, store.domain].join('_')
})
</script>

Or, the more clean way would be to create a composable:

typescript
export default function (suffix: string): string | undefined {
  // Makes sure the rest of the code is not bundled in the client bundle.
  if (import.meta.client) {
    return
  }

  const store = useStore()
  return [store.language, store.currency, store.domain, suffix].join('_')
}

And then use it like this:

vue
<template>
  <RenderCacheable :cache-key>
    <Navbar />
  </RenderCacheable>
</template>

<script lang="ts" setup>
const cacheKey = useGlobalContextKey('additional-suffix')
</script>

CDN Cache Control ​

This works the exact same way as with the route cache, just using the useCDNHeaders composable:

For pages ​

vue
<template>
  <div class="app">
    <NuxtLayout>
      <NuxtPage />
    </NuxtLayout>
  </div>
</template>

<script lang="ts" setup>
useCDNHeaders((helper) => {
  helper.public().setNumeric('maxAge', 604800)
})
</script>

For any route ​

typescript
export default defineEventHandler((event) => {
  useCDNHeaders((helper) => {
    helper.public().setNumeric('maxAge', 604800)
  }, event)
})

The responses of the module's API stay private. Make sure that no other route that returns user-specific data is marked as public this way: Call private() in these routes, which a later public() can't undo.

Released under the MIT License.