useRuntimeHook

Nuxtアプリケーションでランタイムフックを登録し、スコープが破棄されたときに適切に処理されることを保証します。

このコンポーザブルはNuxt v3.14+で利用可能です。

signature

function useRuntimeHook<THookName extends keyof RuntimeNuxtHooks>(
  name: THookName,
  fn: RuntimeNuxtHooks[THookName] extends HookCallback ? RuntimeNuxtHooks[THookName] : never
): void

使用法

パラメータ

name: 登録するランタイムフックの名前。完全なリストはこちらで確認できます。
fn: フックがトリガーされたときに実行されるコールバック関数。関数のシグネチャはフック名に基づいて異なります。

戻り値

このコンポーザブルは値を返しませんが、コンポーネントのスコープが破棄されると自動的にフックを解除します。

例

pages/index.vue

// リンクがプリフェッチされるたびに実行されるフックを登録しますが、
// コンポーネントがアンマウントされると自動的にクリーンアップされ（再度呼び出されません）
useRuntimeHook('link:prefetch', (link) => {
  console.log('Prefetching', link)
})

※このページは Nuxt.js 公式ドキュメントの翻訳ページ（非公式）です。

公式ドキュメントの該当ページはこちら：
https://nuxt.com/docs/3.x/api/composables/use-runtime-hook