Nuxt/docs/2.guide/3.going-further/4.kit.md

47 lines
1.4 KiB
Markdown
Raw Normal View History

---
title: "Nuxt Kit"
description: "@nuxt/kit provides features for module authors."
---
# Nuxt Kit
> Nuxt Kit provides composable utilities to make interacting with [Nuxt Hooks](/docs/api/advanced/hooks) and [Nuxt Builder Core](/docs/guide/going-further/internals#the-nuxt-interface) and developing [Nuxt Modules](/docs/guide/going-further/modules) super easy!
## Usage
### Install Dependency
You can install the latest Nuxt Kit by adding it to the `dependencies` section of your `package.json`. However, please consider always explicitly installing the `@nuxt/kit` package even if it is already installed by Nuxt.
```json [package.json]
{
"dependencies": {
"@nuxt/kit": "npm:@nuxt/kit-edge@latest"
}
}
```
### Import Kit Utilities
```js [test.mjs]
import { useNuxt } from '@nuxt/kit'
```
::ReadMore{link="/docs/api/advanced/kit" title="API > Advanced > Kit"}
::
::alert{type="warning"}
Nuxt Kit utilities are only available for modules and not meant to be imported in runtime (components, Vue composables, pages, plugins, or server routes).
::
2023-03-09 11:34:41 +00:00
Nuxt Kit is an [esm-only package](/docs/guide/concepts/esm) meaning that you **cannot** `require('@nuxt/kit')`. As a workaround, use dynamic import in the CommonJS context:
```js [test.cjs]
// This does NOT work!
// const kit = require('@nuxt/kit')
async function main() {
const kit = await import('@nuxt/kit')
}
main()
```