Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dulnan/nuxt-multi-cache
Advanced caching of components, routes and data for Nuxt 3. Dynamically define CDN cache control headers. Provides cache management API for purging items by key or using cache tags.
https://github.com/dulnan/nuxt-multi-cache
cache nuxt nuxt-module nuxt3 nuxtjs performance ssr vue
Last synced: about 3 hours ago
JSON representation
Advanced caching of components, routes and data for Nuxt 3. Dynamically define CDN cache control headers. Provides cache management API for purging items by key or using cache tags.
- Host: GitHub
- URL: https://github.com/dulnan/nuxt-multi-cache
- Owner: dulnan
- License: mit
- Created: 2021-01-30T12:28:44.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-25T12:30:47.000Z (about 1 month ago)
- Last Synced: 2024-09-23T18:05:10.006Z (about 23 hours ago)
- Topics: cache, nuxt, nuxt-module, nuxt3, nuxtjs, performance, ssr, vue
- Language: TypeScript
- Homepage: https://nuxt-multi-cache.dulnan.net
- Size: 1.97 MB
- Stars: 209
- Watchers: 5
- Forks: 18
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nuxt Multi Cache for Nuxt 3
This module provides several layers of server-side caching for your Nuxt 3 app:
- SSR component caching (caches rendered markup of a component)
- Route caching (pages, API routes)
- Data Caching (generic cache for anything)
- CDN cache control headers (e.g. Cloudflare, Fastly, Varnish)
- API for cache management
- Cache tag based invalidation
**[Documentation](https://nuxt-multi-cache.dulnan.net)** -
**[NPM](https://www.npmjs.com/package/nuxt-multi-cache)**
## Nuxt 2
[Version 1.x](https://github.com/dulnan/nuxt-multi-cache/tree/1.x) (which is in
maintenance mode) supports Nuxt 2.
## Why?
Does your Nuxt app serve thousands of pages from a CMS? Does it have tens of
thousands of requests per day? Does the data change frequently? Does rendering a
single page require fetching data from multiple APIs? If you've answered any of
these questions with "yes", then this module might be for you.
I work fulltime on building frontends with Nuxt for large CMS sites. Rendering a
single page might require up to 10 API calls to get all the data: Menu, footer,
translations, route, page data, user state, additional data... It all adds up
and doing that for every request can quickly become a bottleneck. Maybe you can
work around this problem by getting all the data in a single API call, but I
didn't like to have components dependent on global state.
Instead my solution was to cache the API responses locally on the server. Either
for a fixed amount of time, like 5 minutes, or until the cache entry is being
invalidated. In addition, I cache components that appear on most pages, like
menu or footer.
The hardest thing in IT is cache invalidation, so I also added a way to
invalidate cache entries by key or using cache tags.
# Features
## Component caching
Use the `` wrapper component to cache the markup of the default
slot:
```vue
```
The component is only rendered once and its markup cached. Afterwards the markup
is directly returned.
## Route caching
Cache rendered pages or custom API responses:
```vue
useRouteCache((route) => {
// Mark the page as cacheable for 1 hour and add a cache tag.
route.setCacheable().setMaxAge(3600).addTags(['page:2'])
})
```
## CDN cache control headers
Manage the cacheability for the current response. This will set the correct
cache control and cache tags headers for Cloudflare, Fastly and other cache
providers:
```vue
useCDNHeaders((helper) => {
helper
.public()
.setNumeric('maxAge', 3600)
.setNumeric('staleWhileRevalidate', 21600)
.set('mustRevalidate', true)
.addTags(['page:2', 'image:342'])
})
```
The state is managed inside the current request and can be changed for the
entire duration of the request. The headers are generated right before the
response is sent.
## API
The optional API provides endpoints to manage the caches.