API > wxt > ResolvedConfig

Interface: ResolvedConfig

Contents

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

Properties

alias

alias: Record<string, string>

Import aliases to absolute paths.

Source

packages/wxt/src/types.ts:1211

---

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

---

browser

browser: string

Source

packages/wxt/src/types.ts:1172

---

browserModule

browserModule: "wxt/browser" | "wxt/browser/chrome"

Source

packages/wxt/src/types.ts:1213

---

builtinModules

builtinModules: WxtModule<any>[]

Source

packages/wxt/src/types.ts:1225

---

command

command: WxtCommand

Source

packages/wxt/src/types.ts:1171

---

debug

debug: boolean

Source

packages/wxt/src/types.ts:1165

---

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

Source

packages/wxt/src/types.ts:1216

---

entrypointLoader

entrypointLoader: "vite-node" | "jiti"

Source

packages/wxt/src/types.ts:1214

---

entrypointsDir

entrypointsDir: string

Source

packages/wxt/src/types.ts:1150

---

env

env: ConfigEnv

Source

packages/wxt/src/types.ts:1174

---

experimental

experimental: object

Source

packages/wxt/src/types.ts:1215

---

extensionApi

extensionApi: "chrome" | "webextension-polyfill"

Source

packages/wxt/src/types.ts:1212

---

filterEntrypoints

filterEntrypoints?: Set<string>

Source

packages/wxt/src/types.ts:1152

---

fsCache

fsCache: FsCache

Source

packages/wxt/src/types.ts:1178

---

hooks

hooks: NestedHooks<WxtHooks>

Source

packages/wxt/src/types.ts:1224

---

imports

imports: false | WxtResolvedUnimportOptions

Source

packages/wxt/src/types.ts:1176

---

logger

logger: Logger

Source

packages/wxt/src/types.ts:1175

---

manifest

manifest: Partial<Omit<WebExtensionManifest, "background" | "chrome_url_overrides" | "devtools_page" | "manifest_version" | "options_page" | "options_ui" | "sandbox">>

Source

packages/wxt/src/types.ts:1177

---

manifestVersion

manifestVersion: TargetManifestVersion

Source

packages/wxt/src/types.ts:1173

---

mode

mode: string

Source

packages/wxt/src/types.ts:1170

---

modulesDir

modulesDir: string

Source

packages/wxt/src/types.ts:1151

---

outBaseDir

outBaseDir: string

Absolute path to the .output directory

Example

"/path/to/project/.output"

Source

packages/wxt/src/types.ts:1158

---

outDir

outDir: string

Absolute path to the target output directory.

Example

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

Source

packages/wxt/src/types.ts:1164

---

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

---

publicDir

publicDir: string

Source

packages/wxt/src/types.ts:1142

---

root

root: string

Source

packages/wxt/src/types.ts:1140

---

runnerConfig

runnerConfig: ResolvedConfig<ExtensionRunnerConfig, ConfigLayerMeta>

Source

packages/wxt/src/types.ts:1179

---

srcDir

srcDir: string

Source

packages/wxt/src/types.ts:1141

---

transformManifest

transformManifest?: (manifest) => void

Parameters

▪ manifest: WebExtensionManifest

Returns

Deprecated

Use build:manifestGenerated hook instead.

Source

packages/wxt/src/types.ts:1194

---

typesDir

typesDir: string

Source

packages/wxt/src/types.ts:1149

---

userConfigMetadata

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

Source

packages/wxt/src/types.ts:1207

---

userModules

userModules: WxtModuleWithMetadata<any>[]

Source

packages/wxt/src/types.ts:1226

---

vite

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

Parameters

▪ env: ConfigEnv

Source

packages/wxt/src/types.ts:382

---

wxtDir

wxtDir: string

Absolute path pointing to .wxt directory in project root.

Example

"/path/to/project/.wxt"

Source

packages/wxt/src/types.ts:1148

---

wxtModuleDir

wxtModuleDir: string

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

Source

packages/wxt/src/types.ts:1169

---

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

excludeSources

excludeSources: string[]

includeSources

includeSources: string[]

name

name?: string

sourcesRoot

sourcesRoot: string

sourcesTemplate

sourcesTemplate: string

Source

packages/wxt/src/types.ts:1180

---

Generated using typedoc-plugin-markdown and TypeDoc