WXT

Appearance

API / wxt / WebExtConfig

Interface: WebExtConfig ​

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

Options for how web-ext starts the browser.

Contents ​

Properties ​

binaries? ​

optional binaries?: Record<string, string>

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

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

See ​

chromiumArgs? ​

optional chromiumArgs?: string[]

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

See ​

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

chromiumPort? ​

optional chromiumPort?: number

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

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

chromiumPref? ​

optional chromiumPref?: Record<string, any>

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

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

chromiumProfile? ​

optional chromiumProfile?: string

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

See ​

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

disabled? ​

optional disabled?: boolean

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

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

Default ​

ts
false

firefoxArgs? ​

optional firefoxArgs?: string[]

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

See ​

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

firefoxPref? ​

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

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

See ​

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

firefoxProfile? ​

optional firefoxProfile?: string

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

See ​

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

keepProfileChanges? ​

optional keepProfileChanges?: boolean

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

See ​

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

openConsole? ​

optional openConsole?: boolean

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

See ​

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

openDevtools? ​

optional openDevtools?: boolean

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

See ​

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

startUrls? ​

optional startUrls?: string[]

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

See ​

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

Generated using typedoc-plugin-markdown and TypeDoc