WXT

Appearance

API / wxt / UnlistedScriptDefinition

Interface: UnlistedScriptDefinition ​

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

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 ​

BaseScriptEntrypointOptions.exclude

globalName? ​

optional globalName?: string | boolean | ((entrypoint) => string)

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

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.

Available options:

  • 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.
  • 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.

Default ​

ts
false

Inherited from ​

BaseScriptEntrypointOptions.globalName

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 ​

BaseScriptEntrypointOptions.include

Methods ​

main() ​

main(): any

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

Main function executed when the unlisted script is ran.

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.

Returns ​

any

Generated using typedoc-plugin-markdown and TypeDoc