API / wxt / WxtModuleWithMetadata

Interface: WxtModuleWithMetadata<TOptions>

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

Contents

• Extends
• Type Parameters
  • TOptions
• Properties
  • configKey?
  • hooks?
  • id
  • imports?
  • name?
  • setup?
  • type

Extends

• WxtModule<TOptions>

Type Parameters

TOptions

TOptions extends WxtModuleOptions

Properties

configKey?

optional configKey?: string

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

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

Inherited from

WxtModule.configKey

---

hooks?

optional hooks?: NestedHooks<WxtHooks>

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

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

Inherited from

WxtModule.hooks

---

id

id: string

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

---

imports?

optional imports?: Import[]

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

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

Inherited from

WxtModule.imports

---

name?

optional name?: string

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

Inherited from

WxtModule.name

---

setup?

optional setup?: WxtModuleSetup<TOptions>

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

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

Inherited from

WxtModule.setup

---

type

type: "local" | "node_module"

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

---

Generated using typedoc-plugin-markdown and TypeDoc