useRuntimeHook

ソース
Nuxtアプリケーションでランタイムフックを登録し、スコープが破棄されたときに適切に破棄されるようにします。
このコンポーザブルはNuxt v3.14以降で利用可能です。
署名
function useRuntimeHook<THookName extends keyof RuntimeNuxtHooks> (
  name: THookName,
  fn: RuntimeNuxtHooks[THookName] extends HookCallback ? RuntimeNuxtHooks[THookName] : never
): void

使用方法

パラメーター

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

戻り値

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

例

pages/index.vue
<script setup lang="ts">
// Register a hook that runs every time a link is prefetched, but which will be
// automatically cleaned up (and not called again) when the component is unmounted
useRuntimeHook('link:prefetch', (link) => {
  console.log('Prefetching', link)
})
</script>