Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

nuxt-cache-ssr

Package Overview
Dependencies
Maintainers
1
Versions
11
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

nuxt-cache-ssr

[![NPM version](https://img.shields.io/npm/v/nuxt-cache-ssr.svg)](https://www.npmjs.com/package/nuxt-cache-ssr) [![npm downloads][npm-downloads-src]][npm-downloads-href]

  • 1.1.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
78
decreased by-50.32%
Maintainers
1
Weekly downloads
 
Created
Source

nuxt-cache-ssr

NPM version npm downloads

In Memory Cache middleware for Nuxt3 SSR rendering .

TODO

  • In Memory cache options
  • Custom Key for Page Cache
  • option to disable per enviroment
  • Compress cached response (experimental)
  • Disble page cached on demand (experimental)
  • Regex for Pages
  • Redis Cache
  • Auto refresh cache before expiry (?)

Setup

npm install nuxt-cache-ssr

or

yarn add nuxt-cache-ssr

then inside your nuxt.config.js add cache config:

export default defineNuxtConfig({
  modules: [
    ['nuxt-cache-ssr', {
      // Can be disable per enviroment, like in dev
      enabled: true,
      store: {
        // Plceholder for store type, will be usable after Redis Release
        type: 'memory',
        // maximum number of pages to store in memory
        // if limit is reached, least recently used page
        // is removed.
        max: 500,
        // number of Millisecond to store this page in cache
        ttl: 1000 * 60 // 1 Minute
      },
      pages: [
        // these are prefixes of pages that need to be cached, for caching homepage use '/'
        '/page1',
        '/page2',

      ],
      key: (route: string, headers: any, device: Device) => {
          // Custom function to return cache key
          // return false to bypass cache
        
      }
    }
    ],
  ],

  // ...
})

Configuration

OptionTypeRequiredDescriptionDefault
enabledbooleanNoTo enable/ disable the SSR cachetrue
storeobjectNoSSR cache store options{type:'',max:500,ttl:10000}
pagesArrayYesPages to cacheN/A
keyFunctionNoUse for generating custo key based on route,headers,and device type. Returned string will be hashed using ohash. return false to bypass cacheurl

Device Interface

interface Device {
  userAgent: string
  isDesktop: boolean
  isIos: boolean
  isAndroid: boolean
  isMobile: boolean
  isMobileOrTablet: boolean
  isDesktopOrTablet: boolean
  isTablet: boolean
  isWindows: boolean
  isMacOS: boolean
  isApple: boolean
  isSafari: boolean
  isFirefox: boolean
  isEdge: boolean
  isChrome: boolean
  isSamsung: boolean
  isCrawler: boolean
}

caveat

important security warning : don't load secret keys such as user credential on the server for cached pages. this is because they will cache for all users!

Keywords

FAQs

Package last updated on 10 Nov 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc