简体中文

Rsbuild Types

本章节描述了 Rsbuild 提供的一些类型定义。

RsbuildInstance

Rsbuild 实例的类型，对应 createRsbuild 方法的返回值。

import type { RsbuildInstance } from '@rsbuild/core';

let rsbuild: RsbuildInstance;

Rsbuild 配置的类型。

import type { RsbuildConfig } from '@rsbuild/core';

const config: RsbuildConfig = {
  // ...
};

Rsbuild 配置归一化后的类型，对应 getNormalizedConfig 方法的返回值。

import type { NormalizedConfig } from '@rsbuild/core';

const config: NormalizedConfig = api.getNormalizedConfig();

Rsbuild 实例中 context 属性的类型定义。

import type { RsbuildContext } from '@rsbuild/core';

const context: RsbuildContext = rsbuild.context;

Rsbuild 插件的类型。

import type { RsbuildPlugin } from '@rsbuild/core';

const myPlugin: RsbuildPlugin = {
  name: 'my-plugin',
  setup() {},
};

Rsbuild 插件中，setup 函数传入的 api 对象的类型。

import type { RsbuildPluginAPI } from '@rsbuild/core';

const myPlugin = {
  name: 'my-plugin',
  setup(api: RsbuildPluginAPI) {},
};

Rsbuild 构建产物的类型。

import type { RsbuildTarget } from '@rsbuild/core';

createRsbuild 方法的入参类型。

import type { CreateRsbuildOptions } from '@rsbuild/core';

rsbuild.inspectConfig 方法的入参类型。

import type { InspectConfigOptions } from '@rsbuild/core';