Skip to content

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:1223


chromiumArgs

chromiumArgs?: string[]

See

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

Source

packages/wxt/src/types.ts:1251


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:1245


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",
  },
  }

Source

packages/wxt/src/types.ts:1240


chromiumProfile

chromiumProfile?: string

See

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

Source

packages/wxt/src/types.ts:1227


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:1211


firefoxArgs

firefoxArgs?: string[]

See

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

Source

packages/wxt/src/types.ts:1249


firefoxPref

firefoxPref?: Record<string, string | number | boolean>

See

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

Source

packages/wxt/src/types.ts:1247


firefoxProfile

firefoxProfile?: string

See

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

Source

packages/wxt/src/types.ts:1225


keepProfileChanges

keepProfileChanges?: boolean

See

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

Source

packages/wxt/src/types.ts:1255


openConsole

openConsole?: boolean

See

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

Source

packages/wxt/src/types.ts:1213


openDevtools

openDevtools?: boolean

See

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

Source

packages/wxt/src/types.ts:1215


startUrls

startUrls?: string[]

See

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

Source

packages/wxt/src/types.ts:1253


Generated using typedoc-plugin-markdown and TypeDoc