Zengtudor/Nuxt
1
0
Fork 0
mirror of https://github.com/nuxt/nuxt.git synced 2024-11-14 18:13:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(docs): parameters of installModule

Browse Source
This commit is contained in:
Andrey Yolkin 2023-07-28 18:00:45 +03:00
parent 18bed81f0d
commit 2e87bc8708
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/3.api/4.advanced/2.kit.md
View File

@ -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