Skip to content

API > wxt > WxtDevServer

Interface: WxtDevServer

Contents

Extends

Properties

currentOutput

currentOutput: undefined | BuildOutput

Stores the current build output of the server.

Source

packages/wxt/src/types.ts:490


hostname

hostname: string

Ex: "localhost"

Inherited from

ServerInfo.hostname

Source

packages/wxt/src/types.ts:1104


origin

origin: string

Ex: "http://localhost:3000"

Inherited from

ServerInfo.origin

Source

packages/wxt/src/types.ts:1108


port

port: number

Ex: 3000

Inherited from

ServerInfo.port

Source

packages/wxt/src/types.ts:1100


reloadContentScript

reloadContentScript: (payload) => void

Tell the extension to restart a content script.

Parameters

payload: ReloadContentScriptPayload

Information about the content script to reload.

Source

packages/wxt/src/types.ts:532


reloadExtension

reloadExtension: () => void

Tell the extension to reload by running browser.runtime.reload.

Source

packages/wxt/src/types.ts:514


reloadPage

reloadPage: (path) => void

Tell an extension page to reload.

The path is the bundle path, not the input paths, so if the input paths is "src/options/index.html", you would pass "options.html" because that's where it is written to in the dist directory, and where it's available at in the actual extension.

Parameters

path: string

Returns

Example

ts
server.reloadPage("popup.html")
server.reloadPage("sandbox.html")

Source

packages/wxt/src/types.ts:526


restartBrowser

restartBrowser: () => void

Grab the latest runner config and restart the browser.

Source

packages/wxt/src/types.ts:536


watcher

watcher: FSWatcher

Chokidar file watcher instance.

Inherited from

Omit.watcher

Source

packages/wxt/src/types.ts:1093


ws

ws: object

The web socket server used to communicate with the extension.

Type declaration

on()

Listen for messages over the server's websocket.

Parameters

message: string

cb: (payload) => void

send()

Send a message via the server's websocket, with an optional payload.

Parameters

message: string

payload?: any

Returns
Example
ts
ws.send("wxt:reload-extension");
ws.send("wxt:reload-content-script", { ... });

Inherited from

Omit.ws

Source

packages/wxt/src/types.ts:1076

Methods

restart()

restart(): Promise<void>

Close the browser, stop the server, rebuild the entire extension, and start the server again.

Source

packages/wxt/src/types.ts:502


start()

start(): Promise<void>

Start the server.

Source

packages/wxt/src/types.ts:494


stop()

stop(): Promise<void>

Stop the server.

Source

packages/wxt/src/types.ts:498


transformHtml()

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

Transform the HTML for dev mode.

Parameters

url: string

html: string

originalUrl?: string

Overrides

Omit.transformHtml

Source

packages/wxt/src/types.ts:506


Generated using typedoc-plugin-markdown and TypeDoc