docs: update html plugin filename type

web-infra-dev · Oct 28, 2024 · 52056c0 · 52056c0
1 parent 8447e2c
commit 52056c0
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/website/docs/en/plugins/rspack/html-rspack-plugin.mdx b/website/docs/en/plugins/rspack/html-rspack-plugin.mdx
@@ -138,7 +138,7 @@ You can pass some configuration options to `rspack.HtmlRspackPlugin`. Allowed op
 ```ts
 type HtmlRspackPluginOptions = {
   title?: string;
-  filename?: string;
+  filename?: string | ((entry: string) => string);
   template?: string;
   templateContent?: string | ((params: Record<string, any>) => string | Promise<string>);
   templateParameters?: Record<string, string> | (oldParams: params: Record<string, any>) => Record<string, any> | Promise<Record<string, any>>;
@@ -189,7 +189,7 @@ type HtmlRspackPluginOptions = {
     },
     {
       name: '`filename`',
-      type: '`string|undefined`',
+      type: '`string|undefined|((entry: string) => string)`',
       default: "'index.html'",
       description:
         'The file to write the HTML to. Defaults to `index.html`. You can specify a subdirectory here too (eg: pages/index.html).',

diff --git a/website/docs/zh/plugins/rspack/html-rspack-plugin.mdx b/website/docs/zh/plugins/rspack/html-rspack-plugin.mdx
@@ -138,7 +138,7 @@ module.exports = {
 ```ts
 type HtmlRspackPluginOptions = {
   title?: string;
-  filename?: string;
+  filename?: string | ((entry: string) => string);
   template?: string;
   templateContent?: string | ((params: Record<string, any>) => string | Promise<string>);
   templateParameters?: Record<string, string> | (oldParams: params: Record<string, any>) => Record<string, any> | Promise<Record<string, any>>;
@@ -189,7 +189,7 @@ type HtmlRspackPluginOptions = {
     },
     {
       name: '`filename`',
-      type: '`string|undefined`',
+      type: '`string|undefined|((entry: string) => string)`',
       default: "'index.html'",
       description: '输出的文件名，可以指定子目录，例如 `pages/index.html`',
     },