Skip to content

API > wxt > ResolvedConfig

Interface: ResolvedConfig

Contents

Properties

alias

alias: Record<string, string>

Import aliases to absolute paths.

Source

packages/wxt/src/types/index.ts:1174


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/index.ts:1158


browser

browser: string

Source

packages/wxt/src/types/index.ts:1135


command

command: WxtCommand

Source

packages/wxt/src/types/index.ts:1134


debug

debug: boolean

Source

packages/wxt/src/types/index.ts:1128


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/index.ts:1179


entrypointsDir

entrypointsDir: string

Source

packages/wxt/src/types/index.ts:1113


env

env: ConfigEnv

Source

packages/wxt/src/types/index.ts:1137


experimental

experimental: object

Type declaration

includeBrowserPolyfill

includeBrowserPolyfill: boolean

viteRuntime

viteRuntime: boolean

Source

packages/wxt/src/types/index.ts:1175


filterEntrypoints

filterEntrypoints?: Set<string>

Source

packages/wxt/src/types/index.ts:1115


fsCache

fsCache: FsCache

Source

packages/wxt/src/types/index.ts:1141


hooks

hooks: NestedHooks<WxtHooks>

Source

packages/wxt/src/types/index.ts:1187


imports

imports: false | WxtResolvedUnimportOptions

Source

packages/wxt/src/types/index.ts:1139


logger

logger: Logger

Source

packages/wxt/src/types/index.ts:1138


manifest

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

Source

packages/wxt/src/types/index.ts:1140


manifestVersion

manifestVersion: TargetManifestVersion

Source

packages/wxt/src/types/index.ts:1136


mode

mode: string

Source

packages/wxt/src/types/index.ts:1133


modules

modules: WxtModule<any>[]

Source

packages/wxt/src/types/index.ts:1188


modulesDir

modulesDir: string

Source

packages/wxt/src/types/index.ts:1114


outBaseDir

outBaseDir: string

Absolute path to the .output directory

Example

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

Source

packages/wxt/src/types/index.ts:1121


outDir

outDir: string

Absolute path to the target output directory.

Example

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

Source

packages/wxt/src/types/index.ts:1127


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/index.ts:1196


publicDir

publicDir: string

Source

packages/wxt/src/types/index.ts:1105


root

root: string

Source

packages/wxt/src/types/index.ts:1103


runnerConfig

runnerConfig: ResolvedConfig<ExtensionRunnerConfig, ConfigLayerMeta>

Source

packages/wxt/src/types/index.ts:1142


srcDir

srcDir: string

Source

packages/wxt/src/types/index.ts:1104


transformManifest

transformManifest?: (manifest) => void

Parameters

manifest: WebExtensionManifest

Returns

Deprecated

Use build:manifestGenerated hook instead.

Source

packages/wxt/src/types/index.ts:1157


typesDir

typesDir: string

Source

packages/wxt/src/types/index.ts:1112


userConfigMetadata

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

Source

packages/wxt/src/types/index.ts:1170


vite

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

Parameters

env: ConfigEnv

Source

packages/wxt/src/types/index.ts:382


wxtDir

wxtDir: string

Absolute path pointing to .wxt directory in project root.

Example

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

Source

packages/wxt/src/types/index.ts:1111


wxtModuleDir

wxtModuleDir: string

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

Source

packages/wxt/src/types/index.ts:1132


zip

zip: object

Type declaration

artifactTemplate

artifactTemplate: string

compressionLevel

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

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/index.ts:1143


Generated using typedoc-plugin-markdown and TypeDoc