API / wxt / WxtModule

Interface: WxtModule<TOptions>

Source: packages/wxt/src/types.ts:1807

Contents

• Extended by
• Type Parameters
  • TOptions
• Properties
  • configKey?
  • hooks?
  • imports?
  • name?
  • setup?

Extended by

• WxtModuleWithMetadata

Type Parameters

TOptions

TOptions extends WxtModuleOptions

Properties

configKey?

optional configKey?: string

Source: packages/wxt/src/types.ts:1813

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

---

hooks?

optional hooks?: NestedHooks<WxtHooks>

Source: packages/wxt/src/types.ts:1820

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

---

imports?

optional imports?: Import[]

Source: packages/wxt/src/types.ts:1815

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

---

name?

optional name?: string

Source: packages/wxt/src/types.ts:1808

---

setup?

optional setup?: WxtModuleSetup<TOptions>

Source: packages/wxt/src/types.ts:1825

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

---

Generated using typedoc-plugin-markdown and TypeDoc