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>