Skip to content

API > wxt > BackgroundEntrypointOptions

Interface: BackgroundEntrypointOptions

Contents

Extends

Properties

exclude

exclude?: string[]

List of target browsers to exclude this entrypoint from. Cannot be used with include. You must choose one of the two options.

Default

ts
undefined

Inherited from

BaseEntrypointOptions.exclude

Source

packages/wxt/src/types.ts:614


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

ts
undefined

Inherited from

BaseEntrypointOptions.include

Source

packages/wxt/src/types.ts:607


persistent

persistent?: PerBrowserOption<boolean>

Source

packages/wxt/src/types.ts:627


ref

ref?: string

Stable identifier for this entrypoint, independent of its filename. Modules like @wxt-dev/entrypoint-refs can use it to emit constant names that do not change when the source file is renamed. Defaults to the entrypoint name.

Default

ts
undefined

Inherited from

BaseEntrypointOptions.ref

Source

packages/wxt/src/types.ts:623


type

type?: PerBrowserOption<"module">

Set to "module" to output the background entrypoint as ESM. ESM outputs can share chunks and reduce the overall size of the bundled extension.

When undefined, the background is bundled individually into an IIFE format.

Default

ts
undefined

Source

packages/wxt/src/types.ts:637


Generated using typedoc-plugin-markdown and TypeDoc