WXT

Appearance

API > wxt > WebExtRunner

Class: WebExtRunner ​

WXT's default ExtensionRunner that uses web-ext to open the browser. It cannot open the browser automatically in some environments, like WSL.

Because web-ext is a peer dependency, this runner falls back on the ManualRunner when the module is not installed.

Contents ​

Extends ​

Implements ​

Constructors ​

new WebExtRunner(config) ​

new WebExtRunner(config): WebExtRunner

Parameters ​

▪ config: ResolvedConfig

Inherited from ​

ManualRunner.constructor

Source ​

packages/wxt/src/core/runners/manual.ts:12

Properties ​

config ​

protected config: ResolvedConfig

Inherited from ​

ManualRunner.config

Source ​

packages/wxt/src/core/runners/manual.ts:12

loggerModulePromise ​

private loggerModulePromise: undefined | Promise<__module>

Source ​

packages/wxt/src/core/runners/web-ext.ts:21

webExt ​

private webExt: undefined | WebExtRunInstance

Source ​

packages/wxt/src/core/runners/web-ext.ts:19

webExtModulePromise ​

private webExtModulePromise: undefined | Promise<object>

Source ​

packages/wxt/src/core/runners/web-ext.ts:20

Methods ​

canOpen() ​

canOpen(): Promise<boolean>

Whether or not this runner actually opens the browser.

Implementation of ​

ExtensionRunner.canOpen

Overrides ​

ManualRunner.canOpen

Source ​

packages/wxt/src/core/runners/web-ext.ts:23

closeBrowser() ​

closeBrowser(): Promise<void>

Implementation of ​

ExtensionRunner.closeBrowser

Source ​

packages/wxt/src/core/runners/web-ext.ts:125

loadLogger() ​

private loadLogger(): Promise<__module>

Source ​

packages/wxt/src/core/runners/web-ext.ts:134

loadWebExt() ​

private loadWebExt(): Promise<object>

Source ​

packages/wxt/src/core/runners/web-ext.ts:129

openBrowser() ​

openBrowser(): Promise<void>

Implementation of ​

ExtensionRunner.openBrowser

Overrides ​

ManualRunner.openBrowser

Source ​

packages/wxt/src/core/runners/web-ext.ts:36

relativeOutDir() ​

protected relativeOutDir(): string

Inherited from ​

ManualRunner.relativeOutDir

Source ​

packages/wxt/src/core/runners/manual.ts:24

Generated using typedoc-plugin-markdown and TypeDoc