WXT

Appearance

API > wxt > BackgroundEntrypoint

Interface: BackgroundEntrypoint ​

Contents ​

Extends ​

Properties ​

inputPath ​

inputPath: string

Absolute path to the entrypoint's input file.

Inherited from ​

BaseEntrypoint.inputPath

Source ​

packages/wxt/src/types.ts:706

name ​

name: string

The entrypoint's name. This is the filename or dirname without the type suffix.

Examples:

  • popup.html → popup
  • options/index.html → options
  • named.sandbox.html → named
  • named.sandbox/index.html → named
  • sandbox.html → sandbox
  • sandbox/index.html → sandbox
  • overlay.content.ts → overlay
  • overlay.content/index.ts → overlay

The name is used when generating an output file: <entrypoint.outputDir>/<entrypoint.name>.<ext>

Inherited from ​

BaseEntrypoint.name

Source ​

packages/wxt/src/types.ts:702

options ​

options: ResolvedPerBrowserOptions<BackgroundEntrypointOptions, never>

Source ​

packages/wxt/src/types.ts:738

outputDir ​

outputDir: string

Absolute path to the entrypoint's output directory. Can be wxt.config.outDir or a subdirectory of it.

Inherited from ​

BaseEntrypoint.outputDir

Source ​

packages/wxt/src/types.ts:711

skipped ​

skipped?: boolean

When true, the entrypoint will not be built by WXT. Normally this is set based on the filterEntrypoints config or the entrypoint's include/exclude options defined inside the file.

See https://wxt.dev/guide/essentials/target-different-browsers.html#filtering-entrypoints

Inherited from ​

BaseEntrypoint.skipped

Source ​

packages/wxt/src/types.ts:719

type ​

type: "background"

Source ​

packages/wxt/src/types.ts:737

Generated using typedoc-plugin-markdown and TypeDoc