WXT

Appearance

API > wxt > ResolvedConfig

Interface: ResolvedConfig ​

Contents ​

Properties ​

alias ​

alias: Record<string, string>

Import aliases to absolute paths.

Source ​

packages/wxt/src/types.ts:1380

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

browser ​

browser: string

Source ​

packages/wxt/src/types.ts:1336

builtinModules ​

builtinModules: WxtModule<any>[]

Source ​

packages/wxt/src/types.ts:1412

command ​

command: WxtCommand

Source ​

packages/wxt/src/types.ts:1335

debug ​

debug: boolean

Source ​

packages/wxt/src/types.ts:1329

dev ​

dev: object

Type declaration ​

reloadCommand ​

reloadCommand: string | false

server ​

server?: object

Only defined during dev command

server.hostname ​

server.hostname: 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 ​
ts
800

Source ​

packages/wxt/src/types.ts:1384

entrypointLoader ​

entrypointLoader: "vite-node" | "jiti"

Source ​

packages/wxt/src/types.ts:1382

entrypointsDir ​

entrypointsDir: string

Source ​

packages/wxt/src/types.ts:1314

env ​

env: ConfigEnv

Source ​

packages/wxt/src/types.ts:1338

experimental ​

experimental: object

Source ​

packages/wxt/src/types.ts:1383

extensionApi ​

extensionApi: "chrome" | "webextension-polyfill"

Source ​

packages/wxt/src/types.ts:1381

filterEntrypoints ​

filterEntrypoints?: Set<string>

Source ​

packages/wxt/src/types.ts:1316

fsCache ​

fsCache: FsCache

Source ​

packages/wxt/src/types.ts:1342

hooks ​

hooks: NestedHooks<WxtHooks>

Source ​

packages/wxt/src/types.ts:1411

imports ​

imports: false | WxtResolvedUnimportOptions

Source ​

packages/wxt/src/types.ts:1340

logger ​

logger: Logger

Source ​

packages/wxt/src/types.ts:1339

manifest ​

manifest: UserManifest

Source ​

packages/wxt/src/types.ts:1341

manifestVersion ​

manifestVersion: TargetManifestVersion

Source ​

packages/wxt/src/types.ts:1337

mode ​

mode: string

Source ​

packages/wxt/src/types.ts:1334

modulesDir ​

modulesDir: string

Source ​

packages/wxt/src/types.ts:1315

outBaseDir ​

outBaseDir: string

Absolute path to the .output directory

Example ​

ts
"/path/to/project/.output"

Source ​

packages/wxt/src/types.ts:1322

outDir ​

outDir: string

Absolute path to the target output directory.

Example ​

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

Source ​

packages/wxt/src/types.ts:1328

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 ​

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

Source ​

packages/wxt/src/types.ts:1421

publicDir ​

publicDir: string

Source ​

packages/wxt/src/types.ts:1306

root ​

root: string

Source ​

packages/wxt/src/types.ts:1304

runnerConfig ​

runnerConfig: ResolvedConfig<ExtensionRunnerConfig, ConfigLayerMeta>

Source ​

packages/wxt/src/types.ts:1343

srcDir ​

srcDir: string

Source ​

packages/wxt/src/types.ts:1305

transformManifest ​

transformManifest?: (manifest) => void

Parameters ​

▪ manifest: WebExtensionManifest

Returns ​

Deprecated ​

Use build:manifestGenerated hook instead.

Source ​

packages/wxt/src/types.ts:1363

typesDir ​

typesDir: string

Source ​

packages/wxt/src/types.ts:1313

userConfigMetadata ​

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

Source ​

packages/wxt/src/types.ts:1376

userModules ​

userModules: WxtModuleWithMetadata<any>[]

Source ​

packages/wxt/src/types.ts:1413

vite ​

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

Parameters ​

▪ env: ConfigEnv

Source ​

packages/wxt/src/types.ts:416

wxtDir ​

wxtDir: string

Absolute path pointing to .wxt directory in project root.

Example ​

ts
"/path/to/project/.wxt"

Source ​

packages/wxt/src/types.ts:1312

wxtModuleDir ​

wxtModuleDir: string

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

Source ​

packages/wxt/src/types.ts:1333

zip ​

zip: object

Type declaration ​

artifactTemplate ​

artifactTemplate: string

compressionLevel ​

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

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

Generated using typedoc-plugin-markdown and TypeDoc