WXT

Appearance

API / wxt / BackgroundDefinition

Interface: BackgroundDefinition ​

Source: packages/wxt/src/types.ts:1033

Contents ​

Extends ​

Properties ​

exclude? ​

optional exclude?: string[]

Source: packages/wxt/src/types.ts:673

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 ​

BackgroundEntrypointOptions.exclude

include? ​

optional include?: string[]

Source: packages/wxt/src/types.ts:666

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 ​

BackgroundEntrypointOptions.include

persistent? ​

optional persistent?: PerBrowserOption<boolean>

Source: packages/wxt/src/types.ts:677

Inherited from ​

BackgroundEntrypointOptions.persistent

type? ​

optional type?: PerBrowserOption<"module">

Source: packages/wxt/src/types.ts:687

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

Inherited from ​

BackgroundEntrypointOptions.type

Methods ​

main() ​

main(): void

Source: packages/wxt/src/types.ts:1038

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

Returns ​

void

Generated using typedoc-plugin-markdown and TypeDoc