WXT

Appearance

API > wxt > WxtHooks

Interface: WxtHooks ​

Contents ​

Properties ​

build:before ​

build:before: (wxt) => HookResult

Called before the build is started in both dev mode and build mode.

Parameters ​

▪ wxt: Wxt

The configured WXT object

Source ​

packages/wxt/src/types.ts:1154

build:done ​

build:done: (wxt, output) => HookResult

Called once the build process has finished. You can add files to the build summary here by pushing to output.publicAssets.

Parameters ​

▪ wxt: Wxt

The configured WXT object

▪ output: Readonly<BuildOutput>

The results of the build

Source ​

packages/wxt/src/types.ts:1162

build:manifestGenerated ​

build:manifestGenerated: (wxt, manifest) => HookResult

Called once the manifest has been generated. Used to transform the manifest by reference before it is written to the output directory.

Parameters ​

▪ wxt: Wxt

The configured WXT object

▪ manifest: WebExtensionManifest

The manifest that was generated

Source ​

packages/wxt/src/types.ts:1169

build:publicAssets ​

build:publicAssets: (wxt, files) => HookResult

Called when public assets are found. You can modify the files list by reference to add or remove public files.

Parameters ​

▪ wxt: Wxt

The configured WXT object

▪ files: ResolvedPublicFile[]

Source ​

packages/wxt/src/types.ts:1194

config:resolved ​

config:resolved: (wxt) => HookResult

Called whenever config is loaded or reloaded. Use this hook to modify config by modifying wxt.config.

Parameters ​

▪ wxt: Wxt

The configured WXT object

Source ​

packages/wxt/src/types.ts:1112

entrypoints:grouped ​

entrypoints:grouped: (wxt, groups) => HookResult

Called once all entrypoints have been grouped into their build groups.

Parameters ​

▪ wxt: Wxt

The configured WXT object

▪ groups: EntrypointGroup[]

Source ​

packages/wxt/src/types.ts:1187

entrypoints:resolved ​

entrypoints:resolved: (wxt, entrypoints) => HookResult

Called once all entrypoints have been loaded from the entrypointsDir. Use wxt.builder.importEntrypoint to load entrypoint options from the file, or manually define them.

Parameters ​

▪ wxt: Wxt

The configured WXT object

▪ entrypoints: Entrypoint[]

The list of entrypoints to be built

Source ​

packages/wxt/src/types.ts:1181

prepare:publicPaths ​

prepare:publicPaths: (wxt, paths) => HookResult

Called before generating the list of public paths inside .wxt/types/paths.d.ts. Use this hook to add additional paths (relative to output directory) WXT doesn't add automatically.

Parameters ​

▪ wxt: Wxt

The configured WXT object

▪ paths: string[]

This list of paths TypeScript allows browser.runtime.getURL to be called with.

Returns ​

Example ​

ts
wxt.hooks.hook('prepare:publicPaths', (wxt, paths) => {
  paths.push('/icons/128.png');
})

Source ​

packages/wxt/src/types.ts:1148

prepare:types ​

prepare:types: (wxt, entries) => HookResult

Called before WXT writes .wxt/tsconfig.json and .wxt/wxt.d.ts, allowing addition of custom references and declarations in wxt.d.ts, or directly modifying the options in tsconfig.json.

Parameters ​

▪ wxt: Wxt

▪ entries: WxtDirEntry[]

Returns ​

Example ​

ts
wxt.hooks.hook("prepare:types", (wxt, entries) => {
  // Add a file, ".wxt/types/example.d.ts", that defines a global
  // variable called "example" in the TS project.
  entries.push({
    path: "types/example.d.ts",
    text: "declare const a: string;",
    tsReference: true,
  });
  // use module to add Triple-Slash Directive in .wxt/wxt.d.ts
  // eg: /// <reference types="@types/example" />
  entries.push({
    module: '@types/example'
 });
})

Source ​

packages/wxt/src/types.ts:1134

ready ​

ready: (wxt) => HookResult

Called after WXT modules are initialized, when the WXT instance is ready to be used. wxt.server isn't available yet, use server:created to get it.

Parameters ​

▪ wxt: Wxt

The configured WXT object

Source ​

packages/wxt/src/types.ts:1107

server:closed ​

server:closed: (wxt, server) => HookResult

Called when the dev server is stopped.

Parameters ​

▪ wxt: Wxt

The configured WXT object

▪ server: WxtDevServer

Same as wxt.server, the object WXT uses to control the dev server.

Source ​

packages/wxt/src/types.ts:1245

server:created ​

server:created: (wxt, server) => HookResult

Called when the dev server is created (and wxt.server is assigned). Server has not been started yet.

Parameters ​

▪ wxt: Wxt

The configured WXT object

▪ server: WxtDevServer

Same as wxt.server, the object WXT uses to control the dev server.

Source ​

packages/wxt/src/types.ts:1233

server:started ​

server:started: (wxt, server) => HookResult

Called when the dev server is started.

Parameters ​

▪ wxt: Wxt

The configured WXT object

▪ server: WxtDevServer

Same as wxt.server, the object WXT uses to control the dev server.

Source ​

packages/wxt/src/types.ts:1239

vite:build:extendConfig ​

vite:build:extendConfig: (entrypoints, viteConfig) => HookResult

Called when WXT has created Vite's config for a build step. Useful if you want to add plugins or update the vite config per entrypoint group.

Parameters ​

▪ entrypoints: readonly Entrypoint[]

The list of entrypoints being built with the provided config.

▪ viteConfig: InlineConfig

The config that will be used for the dev server.

Source ​

packages/wxt/src/types.ts:433

vite:devServer:extendConfig ​

vite:devServer:extendConfig: (config) => HookResult

Called when WXT has created Vite's config for the dev server. Useful if you want to add plugins or update the vite config per entrypoint group.

Parameters ​

▪ config: InlineConfig

Source ​

packages/wxt/src/types.ts:443

zip:done ​

zip:done: (wxt, zipFiles) => HookResult

Called after the entire zip process is complete.

Parameters ​

▪ wxt: Wxt

The configured WXT object

▪ zipFiles: string[]

An array of paths to all created zip files

Source ​

packages/wxt/src/types.ts:1227

zip:extension:done ​

zip:extension:done: (wxt, zipPath) => HookResult

Called after zipping the extension files.

Parameters ​

▪ wxt: Wxt

The configured WXT object

▪ zipPath: string

The path to the created extension zip file

Source ​

packages/wxt/src/types.ts:1210

zip:extension:start ​

zip:extension:start: (wxt) => HookResult

Called before zipping the extension files.

Parameters ​

▪ wxt: Wxt

The configured WXT object

Source ​

packages/wxt/src/types.ts:1204

zip:sources:done ​

zip:sources:done: (wxt, zipPath) => HookResult

Called after zipping the source files (for Firefox).

Parameters ​

▪ wxt: Wxt

The configured WXT object

▪ zipPath: string

The path to the created sources zip file

Source ​

packages/wxt/src/types.ts:1221

zip:sources:start ​

zip:sources:start: (wxt) => HookResult

Called before zipping the source files (for Firefox).

Parameters ​

▪ wxt: Wxt

The configured WXT object

Source ​

packages/wxt/src/types.ts:1215

zip:start ​

zip:start: (wxt) => HookResult

Called before the zip process starts.

Parameters ​

▪ wxt: Wxt

The configured WXT object

Source ​

packages/wxt/src/types.ts:1199

Generated using typedoc-plugin-markdown and TypeDoc