> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/nuxt/nuxt/llms.txt
> Use this file to discover all available pages before exploring further.

# Context

> Context utilities to access the Nuxt instance

# Context

Nuxt Kit provides a set of utilities to help you work with context. These functions enable you to conveniently access the Nuxt instance from the context without having to pass it as an argument.

Nuxt modules allow you to enhance Nuxt's capabilities. They offer a structured way to keep your code organized and modular.

## `useNuxt`

Get the Nuxt instance from the context. It will throw an error if Nuxt is not available.

### Type

```ts theme={null}
function useNuxt(): Nuxt
```

### Return Value

The `useNuxt` function returns the Nuxt instance with the following key properties:

| Property   | Type                                                                      | Description                                                                         |
| ---------- | ------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `options`  | `NuxtOptions`                                                             | The resolved Nuxt configuration.                                                    |
| `hooks`    | `Hookable<NuxtHooks>`                                                     | The Nuxt hook system. Allows registering and listening to lifecycle events.         |
| `hook`     | `(name: string, (...args: any[]) => Promise<void> \| void) => () => void` | Shortcut for `nuxt.hooks.hook`. Registers a callback for a specific lifecycle hook. |
| `callHook` | `(name: string, ...args: any[]) => Promise<any>`                          | Shortcut for `nuxt.hooks.callHook`. Triggers a lifecycle hook manually.             |
| `addHooks` | `(configHooks: NestedHooks) => () => void`                                | Shortcut for `nuxt.hooks.addHooks`. Registers multiple hooks at once.               |

### Usage

```ts theme={null}
import { useNuxt } from '@nuxt/kit'

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

  // Use the nuxt instance
  console.log(nuxt.options)
}
```

### Example: Setting up transpilation

```ts theme={null}
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`

Get the Nuxt instance from the context. It will return `null` if Nuxt is not available.

### Type

```ts theme={null}
function tryUseNuxt(): Nuxt | null
```

### Return Value

The `tryUseNuxt` function returns the Nuxt instance if available, or `null` if Nuxt is not available.

The Nuxt instance has the same properties as described in the `useNuxt` section.

### Usage

```ts theme={null}
import { tryUseNuxt } from '@nuxt/kit'

function setupSomething() {
  const nuxt = tryUseNuxt()

  if (nuxt) {
    // Use the nuxt instance
    console.log(nuxt.options)
  } else {
    console.log('Nuxt is not available')
  }
}
```

### Example: Requiring site config

```ts theme={null}
import { tryUseNuxt } from '@nuxt/kit'

interface SiteConfig {
  title?: string
}

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

## When to use context functions

**Note:** When you're working with the `setup` function in Nuxt modules, Nuxt is already provided as the second argument. This means you can access it directly without needing to call `useNuxt()`.

```ts theme={null}
import { defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  setup(options, nuxt) {
    // Access nuxt directly - no need for useNuxt()
    console.log(nuxt.options)
  },
})
```

Use `useNuxt()` and `tryUseNuxt()` when you're breaking down your module into smaller components that don't receive the Nuxt instance as a parameter.

## Source

[View source on GitHub](https://github.com/nuxt/nuxt/blob/main/packages/kit/src/context.ts)