WXT

Appearance

API > wxt > WebExtConfig

Interface: WebExtConfig ​

Options for how web-ext starts the browser.

Contents ​

Properties ​

binaries ​

binaries?: Record<string, string>

List of browser names and the binary that should be used to open the browser.

See ​

Source ​

packages/wxt/src/types.ts:958

chromiumArgs ​

chromiumArgs?: string[]

See ​

https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#args

Source ​

packages/wxt/src/types.ts:1009

chromiumPort ​

chromiumPort?: number

By default, chrome opens a random port for debugging. Set this value to use a specific port.

Source ​

packages/wxt/src/types.ts:997

chromiumPref ​

chromiumPref?: Record<string, any>

An map of chrome preferences from https://chromium.googlesource.com/chromium/src/+/main/chrome/common/pref_names.h

Example ​

ts
// change your downloads directory
{
  download: {
    default_directory: "/my/custom/dir",
  },
}

Default ​

ts
// Enable dev mode and allow content script sourcemaps
{
  devtools: {
    synced_preferences_sync_disabled: {
      skipContentScripts: false,
    },
  }
  extensions: {
    ui: {
      developer_mode: true,
    },
  }
}

Source ​

packages/wxt/src/types.ts:993

chromiumProfile ​

chromiumProfile?: string

See ​

https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#chromium-profile

Source ​

packages/wxt/src/types.ts:966

disabled ​

disabled?: boolean

Whether or not to open the browser with the extension installed in dev mode.

Default ​

ts
false

Source ​

packages/wxt/src/types.ts:943

firefoxArgs ​

firefoxArgs?: string[]

See ​

https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#args

Source ​

packages/wxt/src/types.ts:1005

firefoxPrefs ​

firefoxPrefs?: Record<string, string>

See ​

https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#pref

Source ​

packages/wxt/src/types.ts:1001

firefoxProfile ​

firefoxProfile?: string

See ​

https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#firefox-profile

Source ​

packages/wxt/src/types.ts:962

keepProfileChanges ​

keepProfileChanges?: boolean

See ​

https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#keep-profile-changes

Source ​

packages/wxt/src/types.ts:1017

openConsole ​

openConsole?: boolean

See ​

https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#browser-console

Source ​

packages/wxt/src/types.ts:947

openDevtools ​

openDevtools?: boolean

See ​

https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#devtools

Source ​

packages/wxt/src/types.ts:951

startUrls ​

startUrls?: string[]

See ​

https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#start-url

Source ​

packages/wxt/src/types.ts:1013

Generated using typedoc-plugin-markdown and TypeDoc