Interface: WxtDevServer
Contents
Extends
Omit<WxtBuilderServer,"listen"|"close">.ServerInfo
Properties
currentOutput
currentOutput:
undefined|BuildOutput
Stores the current build output of the server.
Source
packages/wxt/src/types/index.ts:465
hostname
hostname:
string
Ex: "localhost"
Inherited from
Source
packages/wxt/src/types/index.ts:1031
origin
origin:
string
Ex: "http://localhost:3000"
Inherited from
Source
packages/wxt/src/types/index.ts:1035
port
port:
number
Ex: 3000
Inherited from
Source
packages/wxt/src/types/index.ts:1027
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/index.ts:507
reloadExtension
reloadExtension: () =>
void
Tell the extension to reload by running browser.runtime.reload.
Source
packages/wxt/src/types/index.ts:489
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
server.reloadPage("popup.html")
server.reloadPage("sandbox.html")Source
packages/wxt/src/types/index.ts:501
restartBrowser
restartBrowser: () =>
void
Grab the latest runner config and restart the browser.
Source
packages/wxt/src/types/index.ts:511
watcher
watcher:
FSWatcher
Chokidar file watcher instance.
Inherited from
Omit.watcher
Source
packages/wxt/src/types/index.ts:1020
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
ws.send("wxt:reload-extension");
ws.send("wxt:reload-content-script", { ... });Inherited from
Omit.ws
Source
packages/wxt/src/types/index.ts:1003
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/index.ts:477
start()
start():
Promise<void>
Start the server.
Source
packages/wxt/src/types/index.ts:469
stop()
stop():
Promise<void>
Stop the server.
Source
packages/wxt/src/types/index.ts:473
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/index.ts:481
Generated using typedoc-plugin-markdown and TypeDoc