WXT

Appearance

API / wxt / ResolvedConfig

Interface: ResolvedConfig ​

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

Contents ​

Properties ​

actualBrowser ​

actualBrowser: ActualBrowser

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

The actual browser WXT generates code for, resolved from browser via targetBrowserMap.

alias ​

alias: Record<string, string>

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

Import aliases to absolute paths.

analysis ​

analysis: object

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

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<TemplateType | undefined>

browser ​

browser: string

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

builtinModules ​

builtinModules: WxtModule<any>[]

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

command ​

command: WxtCommand

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

debug ​

debug: boolean

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

dev ​

dev: object

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

reloadCommand ​

reloadCommand: string | false

server? ​

optional server?: object

Only defined during dev command

server.host ​

host: string

server.origin ​

origin: string

server.port ​

port: number

server.strictPort ​

strictPort: boolean

server.watchDebounce ​

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

entrypointsDir ​

entrypointsDir: string

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

env ​

env: ConfigEnv

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

experimental ​

experimental: object

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

escapeUnicode ​

escapeUnicode: boolean

filterEntrypoints? ​

optional filterEntrypoints?: Set<string>

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

fsCache ​

fsCache: FsCache

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

hooks ​

hooks: NestedHooks<WxtHooks>

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

imports ​

imports: WxtResolvedUnimportOptions

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

logger ​

logger: WxtLogger

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

manifest ​

manifest: UserManifest

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

manifestVersion ​

manifestVersion: TargetManifestVersion

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

mode ​

mode: string

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

modulesDir ​

modulesDir: string

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

outBaseDir ​

outBaseDir: string

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

Absolute path to the .output directory

Example ​

ts
'/path/to/project/.output';

outDir ​

outDir: string

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

Absolute path to the target output directory.

Example ​

ts
'/path/to/project/.output/chrome-mv3';

plugins ​

plugins: (string | WxtPluginEntry)[]

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

Plugins registered via addWxtPlugin. Each entry's module should be resolvable by vite, and should export default defineWxtPlugin(...). An optional apply function restricts which entrypoints the plugin loads in.

Example ​

ts
[{ module: '@wxt-dev/module-vue/plugin' }];

publicDir ​

publicDir: string

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

root ​

root: string

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

runner ​

runner: ExtensionRunner

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

Deprecated ​

Use wxt.runner instead of wxt.config.runner

srcDir ​

srcDir: string

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

suppressWarnings ​

suppressWarnings: object

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

List of warning identifiers to suppress during the build process.

firefoxDataCollection? ​

optional firefoxDataCollection?: boolean

firefoxId? ​

optional firefoxId?: boolean

targetBrowsers ​

targetBrowsers: string[]

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

typesDir ​

typesDir: string

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

userConfigMetadata ​

userConfigMetadata: Omit<C12ResolvedConfig<UserConfig>, "config">

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

userModules ​

userModules: WxtModuleWithMetadata<any>[]

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

vite ​

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

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

Parameters ​

env ​

ConfigEnv

Returns ​

WxtViteConfig | Promise<WxtViteConfig>

watchOptions ​

watchOptions: WatchOptions

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

Chokidar options used by dev-mode file watchers.

webExt ​

webExt: ResolvedConfig<WebExtConfig>

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

wxtDir ​

wxtDir: string

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

Absolute path pointing to .wxt directory in project root.

Example ​

ts
'/path/to/project/.wxt';

wxtModuleDir ​

wxtModuleDir: string

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

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

zip ​

zip: object

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

artifactTemplate ​

artifactTemplate: string

compressionLevel ​

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

dotSources ​

dotSources: boolean

downloadedPackagesDir ​

downloadedPackagesDir: string

downloadPackages ​

downloadPackages: string[]

exclude ​

exclude: string[]

excludeSources ​

excludeSources: string[]

includeSources ​

includeSources: string[]

name? ​

optional name?: string

sourcesRoot ​

sourcesRoot: string

sourcesTemplate ​

sourcesTemplate: string

zipSources ​

zipSources: boolean

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

Generated using typedoc-plugin-markdown and TypeDoc