API > wxt > ResolvedConfig

Interface: ResolvedConfig

Contents

• Properties
  • alias
  • analysis
  • browser
  • builtinModules
  • command
  • debug
  • dev
  • entrypointsDir
  • env
  • experimental
  • filterEntrypoints
  • fsCache
  • hooks
  • imports
  • logger
  • manifest
  • manifestVersion
  • mode
  • modulesDir
  • outBaseDir
  • outDir
  • plugins
  • publicDir
  • root
  • runnerConfig
  • srcDir
  • targetBrowsers
  • typesDir
  • userConfigMetadata
  • userModules
  • vite
  • wxtDir
  • wxtModuleDir
  • zip

Properties

alias

alias: Record<string, string>

Import aliases to absolute paths.

Source

packages/wxt/src/types.ts:1370

---

analysis

analysis: object

Type declaration

enabled

enabled: boolean

keepArtifacts

keepArtifacts: boolean

open

open: boolean

outputDir

outputDir: string

The directory where the final stats.html file is located

outputFile

outputFile: string

Absolute file path to the stats.html file

outputName

outputName: string

Name of the stats.html file, minus ".html"

template

template: NonNullable<undefined | TemplateType>

Source

packages/wxt/src/types.ts:1354

---

browser

browser: string

Source

packages/wxt/src/types.ts:1329

---

builtinModules

builtinModules: WxtModule<any>[]

Source

packages/wxt/src/types.ts:1401

---

command

command: WxtCommand

Source

packages/wxt/src/types.ts:1328

---

debug

debug: boolean

Source

packages/wxt/src/types.ts:1322

---

dev

dev: object

Type declaration

reloadCommand

reloadCommand: string | false

server

server?: object

Only defined during dev command

server.host

server.host: string

server.origin

server.origin: string

server.port

server.port: number

server.watchDebounce

server.watchDebounce: number

The milliseconds to debounce when a file is saved before reloading. The only way to set this option is to set the WXT_WATCH_DEBOUNCE environment variable, either globally (like in .bashrc file) or per-project (in .env file).

For example:

# ~/.zshrc
export WXT_WATCH_DEBOUNCE=1000

or

# .env
WXT_WATCH_DEBOUNCE=1000

Default

800

Source

packages/wxt/src/types.ts:1372

---

entrypointsDir

entrypointsDir: string

Source

packages/wxt/src/types.ts:1307

---

env

env: ConfigEnv

Source

packages/wxt/src/types.ts:1332

---

experimental

experimental: object

Source

packages/wxt/src/types.ts:1371

---

filterEntrypoints

filterEntrypoints?: Set<string>

Source

packages/wxt/src/types.ts:1309

---

fsCache

fsCache: FsCache

Source

packages/wxt/src/types.ts:1336

---

hooks

hooks: NestedHooks<WxtHooks>

Source

packages/wxt/src/types.ts:1400

---

imports

imports: WxtResolvedUnimportOptions

Source

packages/wxt/src/types.ts:1334

---

logger

logger: Logger

Source

packages/wxt/src/types.ts:1333

---

manifest

manifest: UserManifest

Source

packages/wxt/src/types.ts:1335

---

manifestVersion

manifestVersion: TargetManifestVersion

Source

packages/wxt/src/types.ts:1331

---

mode

mode: string

Source

packages/wxt/src/types.ts:1327

---

modulesDir

modulesDir: string

Source

packages/wxt/src/types.ts:1308

---

outBaseDir

outBaseDir: string

Absolute path to the .output directory

Example

"/path/to/project/.output"

Source

packages/wxt/src/types.ts:1315

---

outDir

outDir: string

Absolute path to the target output directory.

Example

"/path/to/project/.output/chrome-mv3"

Source

packages/wxt/src/types.ts:1321

---

plugins

plugins: string[]

An array of string to import plugins from. These paths should be resolvable by vite, and they should export default defineWxtPlugin(...).

Example

["@wxt-dev/module-vue/plugin", "wxt-module-google-analytics/plugin"]

Source

packages/wxt/src/types.ts:1410

---

publicDir

publicDir: string

Source

packages/wxt/src/types.ts:1299

---

root

root: string

Source

packages/wxt/src/types.ts:1297

---

runnerConfig

runnerConfig: ResolvedConfig<WebExtConfig, ConfigLayerMeta>

Source

packages/wxt/src/types.ts:1337

---

srcDir

srcDir: string

Source

packages/wxt/src/types.ts:1298

---

targetBrowsers

targetBrowsers: string[]

Source

packages/wxt/src/types.ts:1330

---

typesDir

typesDir: string

Source

packages/wxt/src/types.ts:1306

---

userConfigMetadata

userConfigMetadata: Omit<ResolvedConfig<UserConfig, ConfigLayerMeta>, "config">

Source

packages/wxt/src/types.ts:1366

---

userModules

userModules: WxtModuleWithMetadata<any>[]

Source

packages/wxt/src/types.ts:1402

---

vite

vite: (env) => WxtViteConfig | Promise<WxtViteConfig>

Parameters

▪ env: ConfigEnv

Source

packages/wxt/src/types.ts:396

---

wxtDir

wxtDir: string

Absolute path pointing to .wxt directory in project root.

Example

"/path/to/project/.wxt"

Source

packages/wxt/src/types.ts:1305

---

wxtModuleDir

wxtModuleDir: string

Absolute path pointing to the node_modules/wxt directory, wherever WXT is installed.

Source

packages/wxt/src/types.ts:1326

---

zip

zip: object

Type declaration

artifactTemplate

artifactTemplate: string

compressionLevel

compressionLevel: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

downloadPackages

downloadPackages: string[]

downloadedPackagesDir

downloadedPackagesDir: string

exclude

exclude: string[]

excludeSources

excludeSources: string[]

includeSources

includeSources: string[]

name

name?: string

sourcesRoot

sourcesRoot: string

sourcesTemplate

sourcesTemplate: string

zipSources

zipSources: boolean

If true, when zipping the extension, also zip the sources.

Source

packages/wxt/src/types.ts:1338

---

Generated using typedoc-plugin-markdown and TypeDoc