nuxt.renderRoute(route, context = {})

  • 型: 関数
  • 引数:
    1. 文字列、レンダリングするルート
    2. オプションオブジェクト、付与するコンテキスト、利用できるキー: req 及び res
  • 戻り値: プロミス
    • html: 文字列
    • error: null または オブジェクト
    • redirected: false または オブジェクト

特定のルートをレンダリングします。その際にコンテキストを渡すことができます。

このメソッドはほとんどの場合 nuxt.renderAndGetWindow とともに テストする目的 で使われます。

nuxt.renderRoute はプロダクションモード(dev: false)ではビルド処理の後に実行すると良いでしょう。

例:

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` は常に文字列になります

  // エラーレイアウトが表示されるときは `error` は null ではありません。エラーフォーマットは下記:
  // { statusCode: 500, message: 'エラーメッセージ' }

  // `asyncData()` または `fetch()` 内で `redirect()` が使われたときは `redirected` は `false` ではありません
  // { path: '/other-path', query: {}, status: 302 }
})

間違いを見つけた、またはドキュメントに貢献したいですか? GitHub でこのページを編集する