useRuntimeHook
Nuxtアプリケーションにランタイムフックを登録し、スコープが破棄されたときに適切に破棄されるようにします。
このコンポーザブルはNuxt v3.14以降で使用可能です。
シグネチャ
function useRuntimeHook<THookName extends keyof RuntimeNuxtHooks>(
name: THookName,
fn: RuntimeNuxtHooks[THookName] extends HookCallback ? RuntimeNuxtHooks[THookName] : never
): void
使用方法
パラメータ
name
: 登録するランタイムフックの名前。 すべてのランタイム Nuxt フックのリストはこちら をご覧ください。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>