From 2e87bc8708e626aeb79d30e8a1f48ade91939200 Mon Sep 17 00:00:00 2001 From: Andrey Yolkin Date: Fri, 28 Jul 2023 18:00:45 +0300 Subject: [PATCH] feat(docs): parameters of `installModule` --- docs/3.api/4.advanced/2.kit.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/3.api/4.advanced/2.kit.md b/docs/3.api/4.advanced/2.kit.md index f84f831241..f2389da4cb 100644 --- a/docs/3.api/4.advanced/2.kit.md +++ b/docs/3.api/4.advanced/2.kit.md @@ -24,6 +24,32 @@ Install specified Nuxt module programmatically. This is helpful when your module async function installModule (moduleToInstall: string | NuxtModule, inlineOptions?: any, nuxt?: Nuxt) ``` +#### Parameters + +##### `moduleToInstall` + +**Type**: `string` | `NuxtModule` + +**Required**: `true` + +The module to install. Can be either a string with the module name or a module object itself. + +##### `inlineOptions` + +**Type**: `any` + +**Default**: `{}` + +An object with the module options to be passed to the module's `setup` function. + +##### `nuxt` + +**Type**: `Nuxt` + +**Default**: `useNuxt()` + +Nuxt instance. If not provided, it will be retrieved from the context via `useNuxt()` call. + #### Examples ```ts