WXT

Appearance

API / wxt / Wxt

Interface: Wxt ​

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

Contents ​

Properties ​

builder ​

builder: WxtBuilder

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

The module in charge of executing all the build steps.

To override the entire builder process, set this value in a module's setup function or during the config:resolved hook.

ts
wxt.build = new MyBuilder(wxt.config);

config ​

config: ResolvedConfig

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

entrypointFinder ​

entrypointFinder: EntrypointFinder

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

Service responsible for discovering entrypoints in a project.

To override how entrypoints are discovered, set this value in a module's setup function or during the config:resolved hook.

ts
wxt.entrypointFinder = new MyEntrypointFinder(wxt.config);

hook ​

hook: <NameT>(name, function_, options?) => () => void

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

Alias for wxt.hooks.hook(...).

Type Parameters ​

NameT ​

NameT extends HookKeys<WxtHooks>

Parameters ​

name ​

NameT

function_ ​

InferCallback<WxtHooks, NameT>

options? ​
allowDeprecated? ​

boolean

Returns ​

() => void

hooks ​

hooks: Hookable<WxtHooks>

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

logger ​

logger: WxtLogger

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

Alias for config.logger.

pm ​

pm: WxtPackageManager

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

Package manager utilities.

reloadConfig ​

reloadConfig: () => Promise<void>

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

Reload config file and update wxt.config with the result.

Returns ​

Promise<void>

runner ​

runner: ExtensionRunner

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

Service responsible for opening the browser during dev mode.

To override how the browser is opened, set this value in a module's setup function or during the config:resolved hook.

ts
wxt.runner = new MyRunner(wxt.config);

server? ​

optional server?: WxtDevServer

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

If the dev server was started, it will be available.

Generated using typedoc-plugin-markdown and TypeDoc