JavaScript API#

Rsbuild 提供了一整套 JavaScript API，以便于开发者基于 Rsbuild 开发上层的解决方案。

接入示例#

下面是接入 Rsbuild JavaScript API 的基本示例。

1. 安装 Rsbuild#

你需要安装 @rsbuild/core 包：

npm add @rsbuild/core -D

2. 创建 Rsbuild 实例#

你可以调用 createRsbuild 方法来创建一个 Rsbuild 实例对象：

import { createRsbuild } from '@rsbuild/core';

const rsbuild = await createRsbuild();

createRsbuild 方法提供了一些选项，你可以在 API - createRsbuild 中进一步了解。

3. 调用 Rsbuild 实例方法#

Rsbuild 实例提供了与构建相关的各个方法，你可以根据实际场景来进行使用。

在本地开发场景，建议使用 rsbuild.startDevServer 方法，调用后会启动本地 dev server。

await rsbuild.startDevServer();

成功启动 dev server 后，可以看到以下日志信息：

在生产环境部署场景，建议使用 rsbuild.build 方法，调用后会构建出生产模式产物。

await rsbuild.build();

关于 Rsbuild 实例方法的更多介绍，请阅读 Rsbuild Instance 章节。

通过以上三个步骤，你已经了解了 Rsbuild 基本的使用方法。接下来你可以通过 Rsbuild 插件和 Rsbuild 配置来对构建流程进行定制。

导出格式#

Rsbuild 提供 ES modules 和 CommonJS 两种格式的导出：

import { createRsbuild } from '@rsbuild/core';

const { createRsbuild } = require('@rsbuild/core');

推荐使用更符合社区规范的 ES modules 格式。