diff --git a/website/docs/en/api/javascript-api/instance.mdx b/website/docs/en/api/javascript-api/instance.mdx index 0d0ee3115d..1b63227f53 100644 --- a/website/docs/en/api/javascript-api/instance.mdx +++ b/website/docs/en/api/javascript-api/instance.mdx @@ -467,13 +467,23 @@ Get all the Rsbuild plugins registered in the current Rsbuild instance. - **Type:** ```ts -function GetPlugins(): RsbuildPlugin[]; +function GetPlugins(options?: { + /** + * Get the plugins in the specified environment. + * If environment is not specified, get the global plugins. + */ + environment: string; +}): RsbuildPlugin[]; ``` - **Example:** ```ts +// get all plugins console.log(rsbuild.getPlugins()); + +// get plugins in `web` environment +console.log(rsbuild.getPlugins({ environment: 'web' })); ``` ## rsbuild.removePlugins diff --git a/website/docs/zh/api/javascript-api/instance.mdx b/website/docs/zh/api/javascript-api/instance.mdx index 2bf6fdf37d..0cb152e397 100644 --- a/website/docs/zh/api/javascript-api/instance.mdx +++ b/website/docs/zh/api/javascript-api/instance.mdx @@ -490,13 +490,23 @@ rsbuild.addPlugins([pluginFoo()], { environment: 'node' }); - **类型:** ```ts -function GetPlugins(): RsbuildPlugin[]; +function GetPlugins(options?: { + /** + * Get the plugins in the specified environment. + * If environment is not specified, get the global plugins. + */ + environment: string; +}): RsbuildPlugin[]; ``` - **示例:** ```ts +// get all plugins console.log(rsbuild.getPlugins()); + +// get plugins in `web` environment +console.log(rsbuild.getPlugins({ environment: 'web' })); ``` ## rsbuild.removePlugins