v4 (4.0.0)
Nuxt on GitHub

上下文

源代码
Nuxt Kit提供了一组实用工具，帮助你处理上下文。

Nuxt模块允许你增强Nuxt的功能。它们提供了一种结构化的方式来保持代码的组织性和模块化。如果你想将模块分解为更小的组件，Nuxt提供了useNuxt和tryUseNuxt函数。这些函数使你能够方便地从上下文中访问Nuxt实例，而不必将其作为参数传递。

在Nuxt模块的setup函数中工作时，Nuxt已经作为第二个参数提供。这意味着你可以直接访问它，而无需调用useNuxt()。

useNuxt

从上下文中获取Nuxt实例。如果Nuxt不可用，将抛出错误。

用法

import { useNuxt } from '@nuxt/kit'

const setupSomeFeature = () => {
  const nuxt = useNuxt()

  // 现在可以使用nuxt实例
  console.log(nuxt.options)
}

类型

function useNuxt(): Nuxt

返回值

useNuxt函数返回Nuxt实例，该实例包含Nuxt中所有可用的选项和方法。

属性类型描述
optionsNuxtOptions已解析的Nuxt配置。
hooksHookable<NuxtHooks>Nuxt钩子系统。允许注册和监听生命周期事件。
hook(name: string, (...args: any[]) => Promise<void> | void) => () => voidnuxt.hooks.hook的快捷方式。为特定生命周期钩子注册单个回调。
callHook(name: string, ...args: any[]) => Promise<any>nuxt.hooks.callHook的快捷方式。手动触发生命周期钩子并运行所有注册的回调。
addHooks(configHooks: NestedHooks) => () => voidnuxt.hooks.addHooks的快捷方式。一次性注册多个钩子。

示例

import { useNuxt } from '@nuxt/kit'

export const setupTranspilation = () => {
  const nuxt = useNuxt()

  if (nuxt.options.builder === '@nuxt/webpack-builder') {
    nuxt.options.build.transpile ||= []
    nuxt.options.build.transpile.push('xstate')
  }
}

tryUseNuxt

从上下文中获取Nuxt实例。如果Nuxt不可用，将返回null。

用法

import { tryUseNuxt } from '@nuxt/kit'

function setupSomething () {
  const nuxt = tryUseNuxt()

  if (nuxt) {
    // 现在可以使用nuxt实例
    console.log(nuxt.options)
  } else {
    console.log('Nuxt不可用')
  }
}

类型

function tryUseNuxt(): Nuxt | null

返回值

tryUseNuxt函数在可用时返回Nuxt实例，在Nuxt不可用时返回null。

Nuxt实例的描述见useNuxt部分。

示例

import { tryUseNuxt } from '@nuxt/kit'

interface SiteConfig {
  title?: string
}

export const requireSiteConfig = (): SiteConfig => {
  const nuxt = tryUseNuxt()
  if (!nuxt) {
    return {}
  }
  return nuxt.options.siteConfig
}