API / wxt / WxtBuilder

Interface: WxtBuilder

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

Contents

• Properties
  • name
  • version
• Methods
  • build()
  • createServer()
  • importEntrypoint()
  • importEntrypoints()

Properties

name

name: string

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

Name of tool used to build. Ex: "Vite" or "Webpack".

---

version

version: string

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

Version of tool used to build. Ex: "5.0.2"

Methods

build()

build(group): Promise<BuildStepOutput>

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

Build a single entrypoint group. This is effectively one of the multiple "steps" during the build process.

Parameters

group

EntrypointGroup

Returns

Promise<BuildStepOutput>

---

createServer()

createServer(info): Promise<WxtBuilderServer>

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

Start a dev server at the provided port.

Parameters

info

ServerInfo

Returns

Promise<WxtBuilderServer>

---

importEntrypoint()

importEntrypoint<T>(this, path): Promise<T>

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

Import a JS entrypoint file, returning the default export containing the options.

Type Parameters

T

T

Parameters

this

WxtBuilder

path

string

Returns

Promise<T>

---

importEntrypoints()

importEntrypoints(paths): Promise<Record<string, unknown>[]>

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

Import a list of JS entrypoint files, returning their options.

Parameters

paths

string[]

Returns

Promise<Record<string, unknown>[]>

---

Generated using typedoc-plugin-markdown and TypeDoc