WXT

Appearance

API > wxt > WxtModuleWithMetadata

Interface: WxtModuleWithMetadata<TOptions> ​

Contents ​

Extends ​

Type parameters ​

▪ TOptions extends WxtModuleOptions

Properties ​

configKey ​

configKey?: string

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

Inherited from ​

WxtModule.configKey

Source ​

packages/wxt/src/types.ts:1530

hooks ​

hooks?: NestedHooks<WxtHooks>

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

Inherited from ​

WxtModule.hooks

Source ​

packages/wxt/src/types.ts:1539

id ​

id: string

Source ​

packages/wxt/src/types.ts:1550

imports ​

imports?: Import[]

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

Inherited from ​

WxtModule.imports

Source ​

packages/wxt/src/types.ts:1534

name ​

name?: string

Inherited from ​

WxtModule.name

Source ​

packages/wxt/src/types.ts:1526

setup ​

setup?: WxtModuleSetup<TOptions>

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

Inherited from ​

WxtModule.setup

Source ​

packages/wxt/src/types.ts:1544

type ​

type: "local" | "node_module"

Source ​

packages/wxt/src/types.ts:1549

Generated using typedoc-plugin-markdown and TypeDoc