From 51cc5ca55610d54ae91c97e3facb6d6d43b77fa1 Mon Sep 17 00:00:00 2001 From: Andrey Yolkin Date: Sat, 29 Jul 2023 17:36:39 +0300 Subject: [PATCH] feat(docs): describe `loadNuxtConfig` utility --- docs/3.api/4.advanced/2.kit.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/3.api/4.advanced/2.kit.md b/docs/3.api/4.advanced/2.kit.md index e166e6a82b..8c38dfc9e3 100644 --- a/docs/3.api/4.advanced/2.kit.md +++ b/docs/3.api/4.advanced/2.kit.md @@ -159,7 +159,25 @@ async function buildNuxt (nuxt: Nuxt): Promise Nuxt instance to build. It can be retrieved from the context via `useNuxt()` call. -### `loadNuxtConfig(loadOptions)` +### `loadNuxtConfig` + +Load Nuxt configuration. It will return the promise with the configuration object. + +#### Type + +```ts +async function loadNuxtConfig (opts: LoadNuxtConfigOptions): Promise +``` + +#### Parameters + +##### `opts` + +**Type**: `LoadNuxtConfigOptions` + +**Required**: `true` + +Options to pass in [`c12`](https://github.com/unjs/c12#options) `loadConfig` call. ## Compatibility