Zengtudor
/
Nuxt
mirror of https://github.com/nuxt/nuxt.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: remove deprecated `loadNuxt` options (#24201)

This commit is contained in:
Michael Cole 2023-12-14 15:14:45 -06:00 committed by GitHub
parent 677a144d96
commit 0c04dc094a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 0 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/3.api/5.kit/2.programmatic.md
View File

@ -22,8 +22,6 @@ async function loadNuxt (loadOptions?: LoadNuxtOptions): Promise<Nuxt>
interface LoadNuxtOptions extends LoadNuxtConfigOptions {
dev?: boolean
ready?: boolean
rootDir?: string
config?: LoadNuxtConfigOptions['overrides']
}
```
@ -53,26 +51,6 @@ Loading conditions for Nuxt. `loadNuxt` uses [`c12`](https://github.com/unjs/c12
If set to `true`, Nuxt will be ready to use after the `loadNuxt` call. If set to `false`, you will need to call `nuxt.ready()` to make sure Nuxt is ready to use.
- `rootDir` (optional)
**Type**: `string`
**Default**: `null`
**Deprecated**: Use `cwd` option instead.
The root directory of the Nuxt project.
- `config` (optional)
**Type**: `LoadNuxtConfigOptions['overrides']`
**Default**: `{}`
**Deprecated**: Use `overrides` option instead.
Overrides for the Nuxt configuration.
## `buildNuxt`
Build Nuxt programmatically. It will invoke the builder (currently [@nuxt/vite-builder](https://github.com/nuxt/nuxt/tree/main/packages/vite) or [@nuxt/webpack-builder](https://github.com/nuxt/nuxt/tree/main/packages/webpack)) to bundle the application.