docs: update chunk type (#7552)

web-infra-dev · Aug 13, 2024 · 21dd3df · 21dd3df
1 parent 6174c50
commit 21dd3df
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 36 deletions.
diff --git a/website/docs/en/types/chunk.mdx b/website/docs/en/types/chunk.mdx
@@ -2,26 +2,26 @@
 
 ```ts
 type Chunk = {
-  name?: string;
-  id?: string;
-  ids: string[];
-  idNameHints: string[];
-  filenameTemplate?: string;
-  cssFilenameTemplate?: string;
-  files: Set<string>;
-  runtime: Set<string>;
-  hash?: string;
-  contentHash: Record<string, string>;
-  renderedHash?: string;
-  chunkReason?: string;
-  auxiliaryFiles: Set<string>;
-  isOnlyInitial(): boolean;
+  auxiliaryFiles: ReadonlySet<string>;
   canBeInitial(): boolean;
+  chunkReason?: Readonly<string>;
+  contentHash: Readonly<Record<string, string>>;
+  cssFilenameTemplate?: Readonly<string>;
+  filenameTemplate?: Readonly<string>;
+  files: ReadonlySet<string>;
+  getAllAsyncChunks(): Iterable<Chunk>;
+  getAllInitialChunks(): Iterable<Chunk>;
+  getAllReferencedChunks(): Iterable<Chunk>;
+  get groupsIterable(): Iterable<ChunkGroup>;
+  hash?: Readonly<string>;
   hasRuntime(): boolean;
-  groupsIterable: Set<ChunkGroup>;
-  getAllAsyncChunks(): Set<Chunk>;
-  getAllInitialChunks(): Set<Chunk>;
-  getAllReferencedChunks(): Set<Chunk>;
+  id?: Readonly<string>;
+  idNameHints: ReadonlyArray<string>;
+  ids: ReadonlyArray<string>;
+  isOnlyInitial(): boolean;
+  name?: Readonly<string>;
+  renderedHash?: Readonly<string>;
+  runtime: ReadonlySet<string>;
 };
 ```
 

diff --git a/website/docs/zh/types/chunk.mdx b/website/docs/zh/types/chunk.mdx
@@ -2,26 +2,26 @@
 
 ```ts
 type Chunk = {
-  name?: string;
-  id?: string;
-  ids: string[];
-  idNameHints: string[];
-  filenameTemplate?: string;
-  cssFilenameTemplate?: string;
-  files: Set<string>;
-  runtime: Set<string>;
-  hash?: string;
-  contentHash: Record<string, string>;
-  renderedHash?: string;
-  chunkReason?: string;
-  auxiliaryFiles: Set<string>;
-  isOnlyInitial(): boolean;
+  auxiliaryFiles: ReadonlySet<string>;
   canBeInitial(): boolean;
+  chunkReason?: Readonly<string>;
+  contentHash: Readonly<Record<string, string>>;
+  cssFilenameTemplate?: Readonly<string>;
+  filenameTemplate?: Readonly<string>;
+  files: ReadonlySet<string>;
+  getAllAsyncChunks(): Iterable<Chunk>;
+  getAllInitialChunks(): Iterable<Chunk>;
+  getAllReferencedChunks(): Iterable<Chunk>;
+  get groupsIterable(): Iterable<ChunkGroup>;
+  hash?: Readonly<string>;
   hasRuntime(): boolean;
-  groupsIterable: Set<ChunkGroup>;
-  getAllAsyncChunks(): Set<Chunk>;
-  getAllInitialChunks(): Set<Chunk>;
-  getAllReferencedChunks(): Set<Chunk>;
+  id?: Readonly<string>;
+  idNameHints: ReadonlyArray<string>;
+  ids: ReadonlyArray<string>;
+  isOnlyInitial(): boolean;
+  name?: Readonly<string>;
+  renderedHash?: Readonly<string>;
+  runtime: ReadonlySet<string>;
 };
 ```