### createServer()

Source: https://wxt.dev/api/reference/wxt/interfaces/wxtbuilder

Start a dev server at the provided port.

```APIDOC
## Method: createServer()

### Description

Start a dev server at the provided port.

### Parameters

#### Path Parameters

* **info** (ServerInfo) - Required - Information about the server to create.

### Response

#### Success Response

* **Promise<WxtBuilderServer>** - The created WXT builder server instance.
```

--------------------------------

### Create and Start WXT Dev Server

Source: https://wxt.dev/api/reference/wxt/functions/createserver

Use this snippet to create a new WXT development server instance and start it. An optional inline configuration object can be provided to customize the server's behavior.

```typescript
const server = await wxt.createServer({
    // Enter config...
  });
  await server.start();
```

--------------------------------

### server:started

Source: https://wxt.dev/api/reference/wxt/interfaces/wxthooks

Called when the development server has started.

```APIDOC
## server:started

### Description
Called when the dev server is started.

### Parameters
- **wxt** (Wxt) - The configured WXT object.
- **server** (WxtDevServer) - The object WXT uses to control the dev server. Same as `wxt.server`.

### Source
packages/wxt/src/types.ts:1433
```

--------------------------------

### server:started Hook

Source: https://wxt.dev/api/reference/wxt/interfaces/wxthooks

Called when the dev server has started.

```APIDOC
## server:started Hook

### Description
Called when the dev server has started.

### Signature
`server:started: (wxt, url) => HookResult`

### Parameters
#### Path Parameters
- **wxt** (`Wxt`) - The configured WXT object.
- **url** (`string`) - The URL the dev server is listening on.

### Source
`packages/wxt/src/types.ts:1289`
```

--------------------------------

### Example outBaseDir

Source: https://wxt.dev/api/reference/wxt/interfaces/resolvedconfig

Specifies the absolute path to the project's .output directory.

```typescript
'/path/to/project/.output';
```

--------------------------------

### zip:start

Source: https://wxt.dev/api/reference/wxt/interfaces/wxthooks

Called before the zip process starts.

```APIDOC
## zip:start

### Description
Called before the zip process starts.

### Parameters
- **wxt** (Wxt) - The configured WXT object.

### Source
packages/wxt/src/types.ts:1383
```

--------------------------------

### Start the Development Server

Source: https://wxt.dev/api/reference/wxt/interfaces/wxtdevserver

Initiates the WXT development server. This method is asynchronous and returns a Promise.

```typescript
start(): Promise<void>
```

--------------------------------

### ready Hook

Source: https://wxt.dev/api/reference/wxt/interfaces/wxthooks

Called once WXT is ready to start the dev server or build.

```APIDOC
## ready Hook

### Description
Called once WXT is ready to start the dev server or build.

### Signature
`ready: (wxt) => HookResult`

### Parameters
#### Path Parameters
- **wxt** (`Wxt`) - The configured WXT object.

### Source
`packages/wxt/src/types.ts:1285`
```

--------------------------------

### Example plugins configuration

Source: https://wxt.dev/api/reference/wxt/interfaces/resolvedconfig

An array of strings to import plugins. These paths should be resolvable by Vite and export a default defineWxtPlugin function.

```typescript
['@wxt-dev/module-vue/plugin', 'wxt-module-google-analytics/plugin'];
```

--------------------------------

### zip:extension:start Hook

Source: https://wxt.dev/api/reference/wxt/interfaces/wxthooks

Called when the extension zip file creation starts.

```APIDOC
## zip:extension:start Hook

### Description
Called when the extension zip file creation starts.

### Signature
`zip:extension:start: (wxt) => HookResult`

### Parameters
#### Path Parameters
- **wxt** (`Wxt`) - The configured WXT object.

### Source
`packages/wxt/src/types.ts:1421`
```

--------------------------------

### initialize()

Source: https://wxt.dev/api/reference/wxt/functions/initialize.html

Initializes a new WXT project. This function takes an options object to configure the project setup.

```APIDOC
## Function: initialize()

### Description
Initializes a new WXT project with specified options.

### Signature
`initialize(options: object): Promise<void>`

### Parameters
#### options (`object`)

- **options.directory** (`string`) - The directory for the new project.
- **options.packageManager** (`string`) - The package manager to use (e.g., 'npm', 'yarn', 'pnpm').
- **options.template** (`string`) - The template to use for the new project.
```

--------------------------------

### zip:extension:start

Source: https://wxt.dev/api/reference/wxt/interfaces/wxthooks

Called before zipping the extension files.

```APIDOC
## zip:extension:start

### Description
Called before zipping the extension files.

### Parameters
- **wxt** (Wxt) - The configured WXT object.

### Source
packages/wxt/src/types.ts:1389
```

--------------------------------

### Example outDir

Source: https://wxt.dev/api/reference/wxt/interfaces/resolvedconfig

Specifies the absolute path to the target output directory for a specific browser build.

```typescript
'/path/to/project/.output/chrome-mv3';
```

--------------------------------

### Example wxtDir Path

Source: https://wxt.dev/api/reference/wxt/interfaces/resolvedconfig

Illustrates the expected absolute path format for the .wxt directory in the project root.

```typescript
'/path/to/project/.wxt';
```

--------------------------------

### defineWebExtConfig()

Source: https://wxt.dev/api/reference/wxt/functions/definewebextconfig

Configures how web-ext starts the browser during development. It takes a configuration object and returns a WebExtConfig object.

```APIDOC
## Function: defineWebExtConfig()

> **defineWebExtConfig**(`config`): [`WebExtConfig`]

Configure how [`web-ext`](https://github.com/mozilla/web-ext) starts the browser during development.

### Parameters

▪ **config**: [`WebExtConfig`]

### Source

[packages/wxt/src/core/define-web-ext-config.ts:16](https://github.com/wxt-dev/wxt/blob/9a638449d587f48c2821ca32577c5758346c3290/packages/wxt/src/core/define-web-ext-config.ts#L16)
```

--------------------------------

### server:created

Source: https://wxt.dev/api/reference/wxt/interfaces/wxthooks

Called when the development server is created and `wxt.server` is assigned. The server has not started yet.

```APIDOC
## server:created

### Description
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) - The object WXT uses to control the dev server. Same as `wxt.server`.

### Source
packages/wxt/src/types.ts:1425
```

--------------------------------

### zip:start Hook

Source: https://wxt.dev/api/reference/wxt/interfaces/wxthooks

Called when the zip creation process starts.

```APIDOC
## zip:start Hook

### Description
Called when the zip creation process starts.

### Signature
`zip:start: (wxt) => HookResult`

### Parameters
#### Path Parameters
- **wxt** (`Wxt`) - The configured WXT object.

### Source
`packages/wxt/src/types.ts:1401`
```

--------------------------------

### zip:sources:start

Source: https://wxt.dev/api/reference/wxt/interfaces/wxthooks

Called before zipping the source files (for Firefox).

```APIDOC
## zip:sources:start

### Description
Called before zipping the source files (for Firefox).

### Parameters
- **wxt** (Wxt) - The configured WXT object.

### Source
packages/wxt/src/types.ts:1402
```

--------------------------------

### Install WXT Analytics Module

Source: https://wxt.dev/analytics.html

Install the WXT analytics NPM package. Add the module to your wxt.config.ts.

```bash
pnpm i @wxt-dev/analytics
```

```typescript
export default defineConfig({
  modules: ['@wxt-dev/analytics/module'],
});
```

--------------------------------

### installDependencies

Source: https://wxt.dev/api/reference/wxt/interfaces/wxtpackagemanager

Installs all project dependencies. This function can take options to control the installation process, such as specifying the package manager or performing a dry run.

```APIDOC
## installDependencies

### Description
Installs project dependencies.

### Method
installDependencies

### Parameters
#### Path Parameters
- **options?** (Pick<OperationOptions, "cwd" | "silent" | "packageManager" | "dry" | "corepack"> & object) - Optional - Options to pass to the API call.

### Response
#### Success Response
- **OperationResult** - Result of the installation operation.

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

--------------------------------

### zip:sources:start Hook

Source: https://wxt.dev/api/reference/wxt/interfaces/wxthooks

Called when the zip sources collection starts.

```APIDOC
## zip:sources:start Hook

### Description
Called when the zip sources collection starts.

### Signature
`zip:sources:start: (wxt) => HookResult`

### Parameters
#### Path Parameters
- **wxt** (`Wxt`) - The configured WXT object.

### Source
`packages/wxt/src/types.ts:1405`
```

--------------------------------

### Example outDirTemplate Configuration

Source: https://wxt.dev/api/reference/wxt/interfaces/inlineconfig

Customizes the output directory structure using template variables like browser, manifest version, and build mode.

```typescript
'{{browser}}-mv{{manifestVersion}}'
```

--------------------------------

### Alias Configuration Example

Source: https://wxt.dev/api/reference/wxt/interfaces/inlineconfig

Configure additional paths for the .wxt/tsconfig.json. Use this to add new import aliases pointing to specific files or directories.

```typescript
{ "testing": "src/utils/testing.ts" }
```

--------------------------------

### BackgroundDefinition Methods

Source: https://wxt.dev/api/reference/wxt/interfaces/backgrounddefinition

Defines the main function executed when the background script is started.

```APIDOC
## Interface: BackgroundDefinition

### Methods

#### main()

> **main**(): `void`

Main function executed when the background script is started. Cannot be async.
```

--------------------------------

### Add a Content Script Entrypoint

Source: https://wxt.dev/api/reference/wxt/modules/functions/addentrypoint

This example demonstrates how to add a content script entrypoint to your WXT project. It specifies the input path, output directory, and extracts entrypoint options using `wxt.builder.importEntrypoint`.

```typescript
export default defineWxtModule(async (wxt, options) => {
    const entrypointPath = '/path/to/my-entrypoint.ts';
    addEntrypoint(wxt, {
      type: 'content-script',
      name: 'some-name',
      inputPath: entrypointPath,
      outputDir: wxt.config.outDir,
      options: await wxt.builder.importEntrypoint(entrypointPath),
    });
  });
```

--------------------------------

### Restart the Development Server

Source: https://wxt.dev/api/reference/wxt/interfaces/wxtdevserver

Closes the browser, stops the server, rebuilds the extension, and then starts the server again. This method is asynchronous and returns a Promise.

```typescript
restart(): Promise<void>
```

--------------------------------

### Default Chromium Preferences for Development

Source: https://wxt.dev/api/reference/wxt/interfaces/webextconfig

Example of default Chromium preferences for enabling development mode and allowing content script sourcemaps.

```typescript
// Enable dev mode and allow content script sourcemaps
{
  devtools: {
    synced_preferences_sync_disabled: {
      skipContentScripts: false,
    },
  }
  extensions: {
    ui: {
      developer_mode: true,
    },
  }
}
```

--------------------------------

### Create Analytics Instance Without WXT

Source: https://wxt.dev/analytics.html

Install the NPM package and create a custom analytics instance using createAnalytics. This is for projects not using WXT.

```typescript
// utils/analytics.ts
import { createAnalytics } from '@wxt-dev/analytics';

export const analytics = createAnalytics({
  providers: [
    // ...
  ],
});
```

--------------------------------

### Prepare Types Hook Example

Source: https://wxt.dev/api/reference/wxt/interfaces/wxthooks

This hook is used to modify the entries that WXT uses to generate type definitions. It can be used to add custom type files or reference external type modules.

```typescript
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',
    });
  });
```

--------------------------------

### prepare()

Source: https://wxt.dev/api/reference/wxt/functions/prepare.html

Initializes WXT with the provided inline configuration. This function returns a Promise that resolves when the preparation is complete.

```APIDOC
## Function: prepare()

> **prepare**(`config`): `Promise<void>`

### Description
Initializes WXT with the provided inline configuration. This function returns a Promise that resolves when the preparation is complete.

### Parameters
#### Parameters
- **config** (`InlineConfig`) - Required - The inline configuration object for WXT.
```

--------------------------------

### ready

Source: https://wxt.dev/api/reference/wxt/interfaces/wxthooks

Called after WXT modules are initialized, when the WXT instance is ready to be used. Note that `wxt.server` is not available yet; use `server:created` for that.

```APIDOC
## ready

### Description
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:1271
```

--------------------------------

### build()

Source: https://wxt.dev/api/reference/wxt/functions/build.html

Bundles the extension for production. Returns a promise of the build result. Discovers the `wxt.config.ts` file in the root directory, and merges that config with what is passed in.

```APIDOC
## Function: build()

> **build**(`config`?): `Promise`<[`BuildOutput`](../interfaces/BuildOutput.md)>

Bundles the extension for production. Returns a promise of the build result.
Discovers the `wxt.config.ts` file in the root directory, and merges that
config with what is passed in.

### Parameters

▪ **config?**: [`InlineConfig`](../interfaces/InlineConfig.md)

### Returns

`Promise`<[`BuildOutput`](../interfaces/BuildOutput.md)>

### Example

```ts
// Use config from `wxt.config.ts`
  const res = await build();

  // or override config `from wxt.config.ts`
  const res = await build({
    // Override config...
  });
```
```

--------------------------------

### createServer()

Source: https://wxt.dev/api/reference/wxt/functions/createserver

Creates a development server instance. This function is asynchronous and returns a Promise that resolves to a WxtDevServer object. It accepts an optional inline configuration object.

```APIDOC
## Function: createServer()

> **createServer**(`inlineConfig`?): `Promise`<[`WxtDevServer`](../interfaces/WxtDevServer.md)>

Creates a dev server and pre-builds all the files that need to exist before loading the extension.

### Parameters

▪ **inlineConfig?**: [`InlineConfig`](../interfaces/InlineConfig.md)

### Returns

## Example

```ts
const server = await wxt.createServer({
    // Enter config...
  });
  await server.start();
```
```

--------------------------------

### build:before Hook

Source: https://wxt.dev/api/reference/wxt/interfaces/wxthooks

Called before the build is started in both dev mode and build mode. Allows for pre-build modifications.

```APIDOC
## build:before Hook

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

### Signature
`build:before: (wxt) => HookResult`

### Parameters
#### Path Parameters
- **wxt** (`Wxt`) - The configured WXT object.

### Source
`packages/wxt/src/types.ts:1325`
```

--------------------------------

### build()

Source: https://wxt.dev/api/reference/wxt/interfaces/wxtbuilder

Build a single entrypoint group. This is effectively one of the multiple "steps" during the build process.

```APIDOC
## Method: build()

### Description

Build a single entrypoint group. This is effectively one of the multiple "steps" during the build process.

### Parameters

#### Path Parameters

* **group** (EntrypointGroup) - Required - The entrypoint group to build.

### Response

#### Success Response

* **Promise<BuildStepOutput>** - The output of the build step.
```

--------------------------------

### CopiedPublicFile absoluteSrc Example

Source: https://wxt.dev/api/reference/wxt/interfaces/copiedpublicfile

Specifies the absolute path of the file to be copied. This is the source location on your local filesystem.

```typescript
'/path/to/any/file.css';
```

--------------------------------

### Configure WXT Analytics Provider

Source: https://wxt.dev/analytics.html

Configure an analytics provider in your app.config.ts. This example shows Umami provider configuration.

```typescript
// <srcDir>/app.config.ts
import { umami } from '@wxt-dev/analytics/providers/umami';

export default defineAppConfig({
  analytics: {
    debug: true,
    providers: [
      // ...
    ],
  },
});
```

--------------------------------

### Customize Auto-Import Options

Source: https://wxt.dev/api/reference/wxt/interfaces/inlineconfig

Example of customizing auto-import options by adding a directory to import from. Set to `false` to disable auto-imports.

```typescript
export default defineConfig({
  imports: {
    dirs: ['some-directory'],
  },
});
```

--------------------------------

### Build Extension with wxt.build()

Source: https://wxt.dev/api/reference/wxt/functions/build.html

Use the `build()` function to bundle your extension. You can either rely on the configuration defined in your `wxt.config.ts` file or override specific settings by passing an inline configuration object.

```typescript
import { build } from 'wxt';

// Use config from `wxt.config.ts`
const res = await build();

// or override config `from wxt.config.ts`
const res = await build({
  // Override config...
});
```

--------------------------------

### zip()

Source: https://wxt.dev/api/reference/wxt/functions/zip.html

Builds and zips the extension for distribution. Accepts an optional configuration object to override default settings and returns a promise with a list of all files included in the ZIP.

```APIDOC
## Function: zip()

> **zip**(`config`?): `Promise`<`string`[]>

Build and zip the extension for distribution.

### Parameters

▪ **config?**: [`InlineConfig`](../interfaces/InlineConfig.md)

Optional config that will override your `<root>/wxt.config.ts`.

### Returns

A list of all files included in the ZIP.

### Source

[packages/wxt/src/core/zip.ts:22](https://github.com/wxt-dev/wxt/blob/9a638449d587f48c2821ca32577c5758346c3290/packages/wxt/src/core/zip.ts#L22)
```

--------------------------------

### ensureDependencyInstalled

Source: https://wxt.dev/api/reference/wxt/interfaces/wxtpackagemanager

Ensures that a specific dependency is installed in the project. It accepts the dependency name and optional options like workspace, cwd, or dev.

```APIDOC
## ensureDependencyInstalled

### Description
Ensures dependency is installed.

### Method
ensureDependencyInstalled

### Parameters
#### Path Parameters
- **name** (string) - Required - Name of the dependency.
- **options?** (Pick<OperationOptions, "workspace" | "cwd" | "dev">) - Optional - Options to pass to the API call.

### Response
#### Success Response
- **true | undefined** - Indicates if the dependency was installed or already present.

### Source
packages/wxt/src/types.ts:1673
```

--------------------------------

### typesDir

Source: https://wxt.dev/api/reference/wxt/interfaces/resolvedconfig

Represents the absolute path to the .wxt directory in the project root.

```APIDOC
## typesDir

### Description

Represents the absolute path to the `.wxt` directory in the project root.

### Type

`string`
```

--------------------------------

### WxtDevServer Methods

Source: https://wxt.dev/api/reference/wxt/interfaces/wxtdevserver

This section details the core methods available on the WxtDevServer interface for controlling the development server and its associated processes.

```APIDOC
## start()

### Description
Starts the WXT development server.

### Method
start

### Returns
`Promise<void>`

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

```APIDOC
## stop()

### Description
Stops the WXT development server.

### Method
stop

### Returns
`Promise<void>`

### Source
packages/wxt/src/types.ts:527
```

```APIDOC
## restart()

### Description
Closes the browser, stops the server, rebuilds the entire extension, and starts the server again.

### Method
restart

### Returns
`Promise<void>`

### Source
packages/wxt/src/types.ts:532
```

```APIDOC
## transformHtml(url, html, originalUrl?)

### Description
Transforms the HTML for development mode.

### Method
transformHtml

### Parameters
#### Path Parameters
- **url** (string) - Required - The URL to transform.
- **html** (string) - Required - The HTML content to transform.
- **originalUrl** (string) - Optional - The original URL of the HTML.

### Returns
`Promise<string>`

### Overrides
Omit.transformHtml

### Source
packages/wxt/src/types.ts:534
```

```APIDOC
## reloadPage(path)

### Description
Tells an extension page to reload. The path provided should be the bundle path, not the input path.

### Method
reloadPage

### Parameters
#### Path Parameters
- **path** (string) - Required - The bundle path of the page to reload (e.g., 'options.html').

### Example
ts
```ts
server.reloadPage('popup.html');
server.reloadPage('sandbox.html');
```

### Source
packages/wxt/src/types.ts:553
```

```APIDOC
## reloadContentScript(payload)

### Description
Tells the extension to restart a content script.

### Method
reloadContentScript

### Parameters
#### Path Parameters
- **payload** (ReloadContentScriptPayload) - Required - Information about the content script to reload.

### Source
packages/wxt/src/types.ts:559
```

```APIDOC
## reloadExtension()

### Description
Tells the extension to reload by running `browser.runtime.reload`.

### Method
reloadExtension

### Source
packages/wxt/src/types.ts:540
```

```APIDOC
## restartBrowser()

### Description
Grabs the latest runner config and restarts the browser.

### Method
restartBrowser

### Source
packages/wxt/src/types.ts:561
```

--------------------------------

### importEntrypoints()

Source: https://wxt.dev/api/reference/wxt/interfaces/wxtbuilder

Import a list of JS entrypoint files, returning their options.

```APIDOC
## Method: importEntrypoints()

### Description

Import a list of JS entrypoint files, returning their options.

### Parameters

#### Path Parameters

* **paths** (string[]) - Required - A list of paths to the JS entrypoint files.

### Response

#### Success Response

* **Promise<Record<string, unknown>[]>** - An object where keys are entrypoint names and values are their options.
```

--------------------------------

### Example suppressWarnings Configuration

Source: https://wxt.dev/api/reference/wxt/interfaces/inlineconfig

Configures WXT to suppress specific build warnings, such as those related to Firefox data collection or missing extension IDs.

```typescript
export default defineConfig({
    suppressWarnings: {
      firefoxDataCollection: true,
    },
  });
```

--------------------------------

### include

Source: https://wxt.dev/api/reference/wxt/interfaces/mainworldcontentscriptdefinition

Specifies a list of target browsers for which this entrypoint should be included. If not provided, it defaults to being included in all builds. This option cannot be used with `exclude`.

```APIDOC
## include

### Description
List of target browsers to include this entrypoint in. Defaults to being included in all builds. Cannot be used with `exclude`. You must choose one of the two options.

### Type
`string`[]

### Default
```
undefined
```
```

--------------------------------

### prepare:types Hook

Source: https://wxt.dev/api/reference/wxt/interfaces/wxthooks

Called before WXT writes .wxt/tsconfig.json and .wxt/wxt.d.ts, allowing addition of custom references and declarations.

```APIDOC
## prepare:types Hook

### Description
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`.

### Signature
`prepare:types: (wxt, entries) => HookResult`

### Parameters
#### Path Parameters
- **wxt** (`Wxt`) - The configured WXT object.
- **entries** (`any[]`) - Placeholder for entries, actual type not specified in source.

### Source
`packages/wxt/src/types.ts:1309`
```

--------------------------------

### MainWorldContentScriptEntryPointOptions

Source: https://wxt.dev/api/reference/wxt/interfaces/mainworldcontentscriptentrypointoptions

Configuration options for content scripts running in the main world.

```APIDOC
## MainWorldContentScriptEntryPointOptions

### Description

Options for configuring content scripts that run in the main world.

### Properties

#### `registration`

- **registration** (PerBrowserOption<"runtime" | "manifest">) - Optional - Specify how the content script is registered. Can be "manifest" (default) to add to the manifest's `content_scripts` entry, or "runtime" to use the scripting API for dynamic registration.

#### `runAt`

- **runAt** (PerBrowserOption<undefined | RunAt>) - Optional - Specifies when the content script should run. Defaults to 'documentIdle'. See https://developer.chrome.com/docs/extensions/mv3/content_scripts/.

#### `world`

- **world** ("MAIN") - Required - Specifies that the content script runs in the "MAIN" world. See https://developer.chrome.com/docs/extensions/develop/concepts/content-scripts#isolated_world.
```

--------------------------------

### MainWorldContentScriptEntrypointOptions

Source: https://wxt.dev/api/reference/wxt/interfaces/mainworldcontentscriptentrypointoptions

Options for configuring content scripts that run in the main world.

```APIDOC
## MainWorldContentScriptEntrypointOptions

### Description
Options for configuring content scripts that run in the main world.

### Properties

#### globalName
- **globalName** (string | boolean | entrypoint => string) - Optional - The variable name for the IIFE in the output bundle. This option is relevant for scripts inserted into the page context where the default IIFE variable name may conflict with an existing variable on the target page. This applies to content scripts with world=MAIN, and others, such as unlisted scripts, that could be dynamically injected into the page with a `<script>` tag.
  - `true`: automatically generate a name for the IIFE based on the entrypoint name.
  - `false`: Output the IIFE without a variable name, making it anonymous. This is the safest option to avoid conflicts with existing variables on the page. This will become the default in a future version of WXT.
  - `string`: Use the provided string as the global variable name.
  - `function`: A function that receives the entrypoint and returns a string to use as the variable name.
#### include
- **include** (string[]) - Optional - List of target browsers to include this entrypoint in. Defaults to being included in all builds. Cannot be used with `exclude`. You must choose one of the two options.
#### includeGlobs
- **includeGlobs** (PerBrowserOption<undefined | string[]>) - Optional - See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
#### matchAboutBlank
- **matchAboutBlank** (PerBrowserOption<undefined | boolean>) - Optional - See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
#### matchOriginAsFallback
- **matchOriginAsFallback** (PerBrowserOption<boolean>) - Optional - See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
#### matches
- **matches** (PerBrowserOption<string[]>) - Optional - See https://developer.chrome.com/docs/extensions/mv3/content_scripts/
#### noScriptStartedPostMessage
- **noScriptStartedPostMessage** (boolean) - Optional - Do not send the `wxt:content-script-started` message via `window.postMessage`. This has been replaced with custom events. The `postMessage` call is kept for backwards compatibility. For some websites the `postMessage` call is undesirable, such as those with poorly written message event listeners. Setting this to `true` opts into the behavior that will become the default in a future version of WXT, where the `postMessage` call is removed entirely.
```

--------------------------------

### CopiedPublicFile relativeDest Example

Source: https://wxt.dev/api/reference/wxt/interfaces/copiedpublicfile

Defines the destination path for the file within the output directory. This path is relative to the root of your browser extension's build output.

```typescript
'content-scripts/base-styles.css';
```

--------------------------------

### BaseScriptEntrypointOptions Interface

Source: https://wxt.dev/api/reference/wxt/interfaces/basescriptentrypointoptions

Configuration options for script entrypoints, including browser inclusion/exclusion and global name for IIFE.

```APIDOC
## Interface: BaseScriptEntrypointOptions

### Description
Configuration options for script entrypoints.

### Properties

#### exclude
- **Type**: `string[]`
- **Optional**: Yes
- **Description**: List of target browsers to exclude this entrypoint from. Cannot be used with `include`.
- **Default**: `undefined`

#### globalName
- **Type**: `string` | `boolean` | (`entrypoint`) => `string`
- **Optional**: Yes
- **Description**: The variable name for the IIFE in the output bundle. Can be `true` (auto-generate), `false` (anonymous IIFE), a `string` (specific name), or a `function` (dynamic name).
- **Default**: `true`

#### include
- **Type**: `string[]`
- **Optional**: Yes
- **Description**: List of target browsers to include this entrypoint in. Defaults to being included in all builds. Cannot be used with `exclude`.
- **Default**: `undefined`
```

--------------------------------

### WebExtConfig Properties

Source: https://wxt.dev/api/reference/wxt/interfaces/webextconfig

The WebExtConfig interface provides various properties to customize browser behavior when starting with web-ext. These include options for browser binaries, arguments, profiles, and developer tools.

```APIDOC
## Interface: WebExtConfig

Options for how `web-ext` starts the browser.

### Properties

#### binaries

> **binaries**?: `Record<string, string>`

List of browser names and the binary that should be used to open the browser.

* See: https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#chromium-binary, https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#firefox

#### chromiumArgs

> **chromiumArgs**?: `string[]`

* See: https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#args

#### chromiumPort

> **chromiumPort**?: `number`

By default, chrome opens a random port for debugging. Set this value to use a specific port.

#### chromiumPref

> **chromiumPref**?: `Record<string, any>`

An map of chrome preferences from https://chromium.googlesource.com/chromium/src/+/main/chrome/common/pref_names.h

* Example:
```ts
// change your downloads directory
  {
  download: {
  default_directory: "/my/custom/dir",
  },
  }
```

* Default:
```ts
// Enable dev mode and allow content script sourcemaps
{
  devtools: {
    synced_preferences_sync_disabled: {
      skipContentScripts: false,
    },
  }
  extensions: {
    ui: {
      developer_mode: true,
    },
  }
}
```

#### chromiumProfile

> **chromiumProfile**?: `string`

* See: https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#chromium-profile

#### disabled

> **disabled**?: `boolean`

Whether or not to open the browser with the extension installed in dev mode.

* Default:
```ts
false
```

#### firefoxArgs

> **firefoxArgs**?: `string[]`

* See: https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#args

#### firefoxPref

> **firefoxPref**?: `Record<string, string | number | boolean>`

* See: https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#pref

#### firefoxProfile

> **firefoxProfile**?: `string`

* See: https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#firefox-profile

#### keepProfileChanges

> **keepProfileChanges**?: `boolean`

* See: https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#keep-profile-changes

#### openConsole

> **openConsole**?: `boolean`

* See: https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#browser-console

#### openDevtools

> **openDevtools**?: `boolean`

* See: https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#devtools

#### startUrls

> **startUrls**?: `string[]`

* See: https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#start-url

```

--------------------------------

### Default enabled value for Eslintrc

Source: https://wxt.dev/api/reference/wxt/interfaces/eslintrc

The default value for the 'enabled' property is 'auto', which automatically determines whether to generate an ESLint config file based on ESLint's installation.

```typescript
auto
```

--------------------------------

### Default Entrypoints Directory

Source: https://wxt.dev/api/reference/wxt/interfaces/inlineconfig

The default directory for entrypoints in the WXT project.

```typescript
'${config.srcDir}/entrypoints'
```

--------------------------------

### Add Import Alias with Generated File

Source: https://wxt.dev/api/reference/wxt/modules/functions/addalias

This example demonstrates how to generate a type definition file and then add an import alias to it using `addAlias`. This is useful for providing access to code generated by a module, such as an i18n plugin.

```typescript
import path from 'node:path';

  export default defineWxtModule((wxt) => {
    const i18nPath = path.resolve(wxt.config.wxtDir, 'i18n.ts');

    // Generate the file
    wxt.hooks.hook('prepare:types', (_, entries) => {
      entries.push({
        path: i18nPath,
        text: `export const i18n = ...`,
      });
    });

    // Add alias
    addAlias(wxt, '#i18n', i18nPath);
  });
```

--------------------------------

### BaseContentScriptEntrypointOptions

Source: https://wxt.dev/api/reference/wxt/interfaces/basecontentscriptentrypointoptions

Configuration options for content script entry points.

```APIDOC
## Interface: BaseContentScriptEntrypointOptions

Configuration options for content script entry points.

### Properties

#### `globalName`

> **globalName**?: `string`

Inherited from [`BaseScriptEntrypointOptions`](BaseScriptEntrypointOptions.md).[`globalName`](BaseScriptEntrypointOptions.md#globalname)

#### `include`

> **include**?: `string`[]

List of target browsers to include this entrypoint in. Defaults to being included in all builds. Cannot be used with `exclude`. You must choose one of the two options.

Default: `undefined`

#### `includeGlobs`

> **includeGlobs**?: `PerBrowserOption` < `undefined` | `string`[] >

See https://developer.chrome.com/docs/extensions/mv3/content_scripts/

Default: `[]`

#### `matchAboutBlank`

> **matchAboutBlank**?: `PerBrowserOption` < `undefined` | `boolean` >

See https://developer.chrome.com/docs/extensions/mv3/content_scripts/

Default: `false`

#### `matchOriginAsFallback`

> **matchOriginAsFallback**?: `PerBrowserOption` < `boolean` >

See https://developer.chrome.com/docs/extensions/mv3/content_scripts/

Default: `false`

#### `matches`

> **matches**?: `PerBrowserOption` < `string`[] >

#### `noScriptStartedPostMessage`

> **noScriptStartedPostMessage**?: `boolean`

Do not send the `wxt:content-script-started` message via `window.postMessage`.

This has been replaced with custom events. The `postMessage` call is kept for backwards compatibility. For some websites the `postMessage` call is undesirable, such as those with poorly written message event listeners.

Setting this to `true` opts into the behavior that will become the default in a future version of WXT, where the `postMessage` call is removed entirely.

See https://github.com/wxt-dev/wxt/pull/1938 and https://github.com/wxt-dev/wxt/pull/2035 for a detailed discussion.

#### `registration`

> **registration**?: `PerBrowserOption` < `"runtime"` | `"manifest"` >

Specify how the content script is registered.

* `"manifest"`: The content script will be added to the `content_scripts` entry in the manifest. This is the normal and most well known way of registering a content script.
* `"runtime"`: The content script's `matches` is added to `host_permissions` and you are responsible for using the scripting API to register/execute the content script dynamically at runtime.

Default: `'manifest'`

#### `runAt`

> **runAt**?: `PerBrowserOption` < `undefined` | `RunAt` >

See https://developer.chrome.com/docs/extensions/mv3/content_scripts/

Default: `'documentIdle'`: 
```

--------------------------------

### WxtModuleWithMetadata Interface

Source: https://wxt.dev/api/reference/wxt/interfaces/wxtmodulewithmetadata

The WxtModuleWithMetadata interface defines the structure for modules within the WXT framework, including configuration keys, hooks, unique identifiers, imports, setup functions, and module types. It extends the base WxtModule interface.

```APIDOC
## Interface: WxtModuleWithMetadata<TOptions>

### Type parameters

▪ **TOptions** extends `WxtModuleOptions`

### Properties

* **configKey**?: `string`
  Key for users to pass options into your module from their `wxt.config.ts` file.
  * Inherited from `WxtModule`.*

* **hooks**?: `NestedHooks<WxtHooks>`
  Alternative to adding hooks in setup function with `wxt.hooks`. Hooks are added before the `setup` function is called.
  * Inherited from `WxtModule`.*

* **id**: `string`
  Unique identifier for the module.

* **imports**?: `Import[]`
  Provide a list of imports to add to auto-imports.
  * Inherited from `WxtModule`.*

* **name**?: `string`
  * Inherited from `WxtModule`.*

* **setup**?: `WxtModuleSetup<TOptions>`
  A custom function that can be used to setup hooks and call module-specific APIs.
  * Inherited from `WxtModule`.*

* **type**: `"local" | "node_module"`
  The type of the module, either 'local' or 'node_module'.
```

--------------------------------

### wxtDir

Source: https://wxt.dev/api/reference/wxt/interfaces/resolvedconfig

Absolute path pointing to the .wxt directory in the project root.

```APIDOC
## wxtDir

### Description

Absolute path pointing to `.wxt` directory in project root.

### Example

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

### Type

`string`
```

--------------------------------

### WxtModule Interface

Source: https://wxt.dev/api/reference/wxt/interfaces/wxtmodule

The WxtModule interface defines the structure for WXT modules, allowing developers to configure their behavior and integrate with the WXT framework. It includes properties for configuration keys, hooks, imports, module name, and a setup function.

```APIDOC
## Interface: WxtModule`<TOptions>`

### Type parameters

* **TOptions** extends `WxtModuleOptions`

### Properties

#### configKey

* **configKey**?: `string`
  Key for users to pass options into your module from their `wxt.config.ts` file.

#### hooks

* **hooks**?: `NestedHooks`<`WxtHooks`>
  Alternative to adding hooks in setup function with `wxt.hooks`. Hooks are added before the `setup` function is called.

#### imports

* **imports**?: `Import`[]
  Provide a list of imports to add to auto-imports.

#### name

* **name**?: `string`

#### setup

* **setup**?: `WxtModuleSetup`<`TOptions`>
  A custom function that can be used to setup hooks and call module-specific APIs.
```

--------------------------------

### Default outDir Configuration

Source: https://wxt.dev/api/reference/wxt/interfaces/inlineconfig

Sets the output directory for build artifacts. Defaults to '.output'.

```typescript
'.output'
```

--------------------------------

### importEntrypoint()

Source: https://wxt.dev/api/reference/wxt/interfaces/wxtbuilder

Import a JS entrypoint file, returning the default export containing the options.

```APIDOC
## Method: importEntrypoint() <T>

### Description

Import a JS entrypoint file, returning the default export containing the options.

### Type Parameters

* **T** - The type of the default export.

### Parameters

#### Path Parameters

* **path** (string) - Required - The path to the JS entrypoint file.

### Response

#### Success Response

* **Promise<T>** - The default export of the entrypoint file.
```

--------------------------------

### entrypoints:resolved Hook

Source: https://wxt.dev/api/reference/wxt/interfaces/wxthooks

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.

```APIDOC
## entrypoints:resolved Hook

### Description
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.

### Signature
`entrypoints:resolved: (wxt, entrypoints) => HookResult`

### Parameters
#### Path Parameters
- **wxt** (`Wxt`) - The configured WXT object.
- **entrypoints** (`Entrypoint[]`) - The list of entrypoints to be built.

### Source
`packages/wxt/src/types.ts:1361`
```

--------------------------------

### runAt

Source: https://wxt.dev/api/reference/wxt/interfaces/isolatedworldcontentscriptentrypointoptions

Determines when the content script is executed. Options include 'documentIdle', 'documentEnd', and 'documentStart'.

```APIDOC
## runAt

### Description

See https://developer.chrome.com/docs/extensions/mv3/content_scripts/

### Type

`undefined | RunAt`

### Default

`'documentIdle'`
```

--------------------------------

### EntrypointInfo Interface

Source: https://wxt.dev/api/reference/wxt/interfaces/entrypointinfo

This interface describes the properties of a WXT entrypoint. It includes the absolute path to the entrypoint file, its name, and its type.

```APIDOC
## Interface: EntrypointInfo

### Description

Defines the structure for WXT entrypoints.

### Properties

#### inputPath

- **inputPath** (`string`) - Required - Absolute path to the entrypoint file.

#### name

- **name** (`string`) - Required - The name of the entrypoint.

#### type

- **type** (`"background" | "unlisted-script" | "devtools" | "options" | "bookmarks" | "history" | "sandbox" | "newtab" | "unlisted-page" | "unlisted-style" | "content-script-style" | "content-script" | "popup" | "sidepanel"`) - Required - The type of the entrypoint. Possible values include background, content-script, popup, etc.
```

--------------------------------

### WxtBuilderServer Methods

Source: https://wxt.dev/api/reference/wxt/interfaces/wxtbuilderserver

This section details the methods available on the WxtBuilderServer interface for managing the WXT development server.

```APIDOC
## Methods

### close()

> **close**(): `Promise`<`void`>

Stop the server.

### listen()

> **listen**(): `Promise`<`void`>

Start the server.

### on()

> **`optional`****on**(`event`, `callback`): `void`

#### Parameters

▪ **event** : `string`

▪ **callback** : () => `void`

### transformHtml()

> **transformHtml**(`url`, `html`, `originalUrl`?): `Promise`<`string`>

Transform the HTML for dev mode.

#### Parameters

▪ **url** : `string`

▪ **html** : `string`

▪ **originalUrl?** : `string`
```

--------------------------------

### BaseEntrypoint Interface Documentation

Source: https://wxt.dev/api/reference/wxt/interfaces/baseentrypoint

Details the properties of the BaseEntrypoint interface, which serves as a base for various WXT entrypoint configurations.

```APIDOC
## Interface: BaseEntrypoint

This interface defines the common properties for all WXT entrypoints.

### Properties

*   **inputPath** (`string`): Absolute path to the entrypoint's input file.
*   **name** (`string`): The entrypoint's name, derived from its filename or directory.
*   **outputDir** (`string`): Absolute path to the directory where the entrypoint's output will be placed.
*   **skipped** (`boolean`, optional): If true, WXT will not build this entrypoint.

### Extended By

This interface is extended by the following entrypoint types:

*   `GenericEntrypoint`
*   `UnlistedScriptEntrypoint`
*   `BackgroundEntrypoint`
*   `ContentScriptEntrypoint`
*   `PopupEntrypoint`
*   `OptionsEntrypoint`
*   `SidepanelEntrypoint`
```

--------------------------------

### WXT Module Functions

Source: https://wxt.dev/api/reference/wxt/modules

This section lists the available functions for creating and configuring WXT Modules. These functions allow you to manage aliases, entrypoints, import presets, public assets, Vite configurations, WXT plugins, and define WXT modules.

```APIDOC
## Functions

### addAlias

Adds an alias for module resolution.

### addEntrypoint

Adds a new entrypoint to the WXT build.

### addImportPreset

Adds a preset for handling module imports.

### addPublicAssets

Includes public assets in the WXT build.

### addViteConfig

Adds custom Vite configuration to the WXT build.

### addWxtPlugin

Adds a WXT plugin to the build process.

### defineWxtModule

Defines a WXT module.
```

--------------------------------

### main()

Source: https://wxt.dev/api/reference/wxt/interfaces/mainworldcontentscriptdefinition

The main function executed when the content script is loaded. If the content script is executed using `browser.scripting.executeScript`, the return value of this function will be included in the result of `executeScript`. Otherwise, returning a value has no effect.

```APIDOC
## main()

> **main**(): `any`

Main function executed when the content script is loaded.

When running a content script with `browser.scripting.executeScript`,
values returned from this function will be returned in the `executeScript`
result as well. Otherwise returning a value does nothing.
```

--------------------------------

### addEntrypoint()

Source: https://wxt.dev/api/reference/wxt/modules/functions/addentrypoint

Adds a TypeScript or JavaScript file as an entrypoint to the WXT project. The provided file will be bundled with other entrypoints. It's recommended to use `addPublicAssets` for NPM modules to copy pre-built assets instead of bundling.

```APIDOC
## Function: addEntrypoint()

> **addEntrypoint**(`wxt`, `entrypoint`): `void`

Adds a TS/JS file as an entrypoint to the project. This file will be bundled along with the other entrypoints.

If you're publishing the module to NPM, you should probably pre-build the entrypoint and use `addPublicAssets` instead to copy pre-bundled assets into the output directory. This will speed up project builds since it just has to copy some files instead of bundling them.

To extract entrypoint options from a JS/TS file, use `wxt.builder.importEntrypoint` (see example).

### Parameters 

▪ **wxt** : `Wxt`

The wxt instance provided by the module's setup function.

▪ **entrypoint** : `Entrypoint`

The entrypoint to be bundled along with the extension.

### Example 

```ts
export default defineWxtModule(async (wxt, options) => {
    const entrypointPath = '/path/to/my-entrypoint.ts';
    addEntrypoint(wxt, {
      type: 'content-script',
      name: 'some-name',
      inputPath: entrypointPath,
      outputDir: wxt.config.outDir,
      options: await wxt.builder.importEntrypoint(entrypointPath),
    });
  });
```
```