docs: correct onCloseDevServer example (#4464)

web-infra-dev · Jan 31, 2025 · 6a19ff6 · 6a19ff6
1 parent 9606c8e
commit 6a19ff6
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 6 deletions.
diff --git a/website/docs/en/api/javascript-api/core.mdx b/website/docs/en/api/javascript-api/core.mdx
@@ -21,7 +21,7 @@ import { createRsbuild } from '@rsbuild/core';
 
 const rsbuild = await createRsbuild({
   rsbuildConfig: {
-    // rsbuild configs
+    // Rsbuild configuration
   },
 });
 ```

diff --git a/website/docs/en/plugins/dev/hooks.mdx b/website/docs/en/plugins/dev/hooks.mdx
@@ -732,8 +732,12 @@ import OnCloseDevServer from '@en/shared/onCloseDevServer.mdx';
 - **Example:**
 
 ```ts
-rsbuild.onCloseDevServer(async () => {
-  console.log('close dev server!');
+const myPlugin = () => ({
+  setup: (api) => {
+    api.onCloseDevServer(async () => {
+      console.log('close dev server!');
+    });
+  },
 });
 ```
 

diff --git a/website/docs/zh/api/javascript-api/core.mdx b/website/docs/zh/api/javascript-api/core.mdx
@@ -21,7 +21,7 @@ import { createRsbuild } from '@rsbuild/core';
 
 const rsbuild = await createRsbuild({
   rsbuildConfig: {
-    // rsbuild configs
+    // Rsbuild configuration
   },
 });
 ```

diff --git a/website/docs/zh/plugins/dev/hooks.mdx b/website/docs/zh/plugins/dev/hooks.mdx
@@ -728,8 +728,12 @@ import OnCloseDevServer from '@zh/shared/onCloseDevServer.mdx';
 - **示例：**
 
 ```ts
-rsbuild.onCloseDevServer(async () => {
-  console.log('close dev server!');
+const myPlugin = () => ({
+  setup: (api) => {
+    api.onCloseDevServer(async () => {
+      console.log('close dev server!');
+    });
+  },
 });
 ```