Nuxt Kit

Nuxt Kit provides composable utilities to make interacting with Nuxt Hooks and Nuxt Builder Core and developing Nuxt 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.

package.json
{
  "dependencies": {
    "@nuxt/kit": "npm:@nuxt/[email protected]"
  }
}

Import kit utilities

test.mjs
import { useNuxt } from '@nuxt/kit'
👉
Read more in API > Advanced > Kit.
Nuxt kit utilities are only available for modules and not meant to be imported in runtime (components, vue composables, pages, plugins, or server routes)

Nuxt kit, is an esm-only package meaning you cannot require('@nuxt/kit'). As a workaround, we can use dynamic import to use it in the CommonJS context:

test.cjs
// This does NOT work!
// const kit = require('@nuxt/kit')
async function main() {
  const kit = await import('@nuxt/kit')
}
main()
Edit this page on GitHub Updated at Wed, May 25, 2022