nuxt.renderRoute(route, context = {})

  • Type: Function
  • Arguments:
    1. String, route to render
    2. Optional, Object, context given, available keys: req & res
  • Returns: Promise
    • html: String
    • error: null or Object
    • redirected: false or Object

Render a specific route with a given context.

This method should be used mostly for test purposes as well with nuxt.renderAndGetWindow.

nuxt.renderRoute should be executed after the build process in production mode (dev: false).

Example:

const { Nuxt, Builder } = require('nuxt')

const config = require('./nuxt.config.js')
config.dev = false

const nuxt = new Nuxt(config)

new Builder(nuxt)
.build()
.then(() => nuxt.renderRoute('/'))
.then(({ html, error, redirected }) => {
  // html will be always a string

  // error not null when the error layout is displayed, the error format is:
  // { statusCode: 500, message: 'My error message' }

  // redirected is not false when redirect() has been used in data() or fetch()
  // { path: '/other-path', query: {}, status: 302 }
})

Caught a mistake or want to contribute to the documentation? Edit this page on GitHub!