Skip to content

API > wxt > WxtModule

Interface: WxtModule<TOptions> ​

Contents ​

Extended By ​

Type parameters ​

▪ TOptions extends WxtModuleOptions

Properties ​

configKey ​

configKey?: string

Key for users to pass options into your module from their wxt.config.ts file.

Source ​

packages/wxt/src/types.ts:1798


hooks ​

hooks?: NestedHooks<WxtHooks>

Alternative to adding hooks in setup function with wxt.hooks. Hooks are added before the setup function is called.

Source ​

packages/wxt/src/types.ts:1805


imports ​

imports?: Import[]

Provide a list of imports to add to auto-imports.

Source ​

packages/wxt/src/types.ts:1800


name ​

name?: string

Source ​

packages/wxt/src/types.ts:1793


setup ​

setup?: WxtModuleSetup<TOptions>

A custom function that can be used to setup hooks and call module-specific APIs.

Source ​

packages/wxt/src/types.ts:1810


Generated using typedoc-plugin-markdown and TypeDoc