API: コンテキスト

context は Nuxt から Vue コンポーネントへ追加のオブジェクト/パラメータを提供し、asyncDatafetchpluginsmiddleware、そして nuxtServerInit のような特別な nuxt ライフサイクル内で利用可能です。

function (context) {
  // Universal keys
  const {
    app,
    store,
    route,
    params,
    query,
    env,
    isDev,
    isHMR,
    redirect,
    error
  } = context
  // Server-side
  if (process.server) {
    const { req, res, beforeNuxtRender } = context
  }
  // Client-side
  if (process.client) {
    const { from, nuxtState } = context
  }
}

Universal keys

これらのキーはクライアントサイドとサーバーサイド両方で利用可能です。

app (NuxtAppOptions)

すべてのプラグインを含むルートの Vue インスタンス。 たとえば、i18n を使用する場合、context.app.i18n から $i18n にアクセスすることができます。

store (Vuex Store)

Vuex Store インスタンス。vuex store が設定されている場合にのみ利用可能です

route (Vue Router Route)

Vue Router ルートインスタンス。

params (Object)

route.params のエイリアス。

query (Object)

route.query のエイリアス。

env (Object)

nuxt.config.js で設定された環境変数。env api を参照してください。

isDev (Boolean)

開発モードであるかどうかを知らせます。プロダクション環境でデータをキャッシュさせる場合などに便利です。

isHMR (Boolean)

メソッド/ミドルウェアが webpack の hot module replacement(開発モードでのクライアントサイドに限る)から呼び出されたかどうかを知らせます。

redirect (Function)

ユーザーを別のルートにリダイレクトさせます。ステータスコードはサーバーサイドで使用され、デフォルトは 302 です。redirect([status,] path [, query])

error (Function)

エラーページを表示します。error(params) のように呼びます。paramsstatusCodemessage の 2つのプロパティを持つ必要があります。

Server-side keys

これらのキーはサーバーサイドでのみ利用可能です。

req (http.Request)

Node.js サーバーからのリクエスト。Nuxt がミドルウェアとして使用されている場合、使用しているフレームワークによってリクエストオブジェクトが異なることがあります。
nuxt generate からは使用できません

res (http.Response)

Node.js サーバーからのレスポンス。 Nuxt がミドルウェアとして使用されている場合、使用しているフレームワークに応じてレスポンスオブジェクトが異なることがあります。
nuxt generate からは使用できません

beforeNuxtRender(fn) (Function)

クライアントサイドでレンダリングされた __NUXT__ 変数がアップデートされます。fn(非同期にすることができます)は { Components, nuxtState } と共に呼ばれます。詳細はを参照してください。

Client-side keys

これらのキーはクライアントサイドでのみ利用可能です。

from (Vue Router Route)

遷移元の route。

nuxtState (Object)

Nuxt の状態。beforeNuxtRender を使用してハイドレーション前にクライアントサイドで nuxt の状態を取得するプラグインに便利です。universal モードでのみ使用できます

Contributors

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

Platinum Sponsors

Storyblok
Support Us