feat(pages): more pages

Author: avivkeller

generate-md.mjs

@@ -1,10 +1,28 @@
 import { Application } from 'typedoc';
+import { rmSync } from 'node:fs';
 import webpack from './webpack/package.json' with { type: 'json' };
 import { major } from 'semver';
 
+const out = `pages/v${major(webpack.version)}.x`;
+
 const app = await Application.bootstrapWithPlugins({
-  entryPoints: ['./webpack/types.d.ts'],
-  out: `pages/v${major(webpack.version)}.x`,
+  // Inputs
+  // `lib` gives us the runtime export surface for the root `webpack` page,
+  // `types.d.ts` gives us the primary declarations, and the declaration files
+  // fill in option/config types that are not re-exported through `types.d.ts`.
+  entryPoints: [
+    './webpack/lib',
+    './webpack/types.d.ts',
+    './webpack/declarations/**/*.d.ts',
+  ],
+
+  // Configuration
+  tsconfig: './tsconfig.typedoc.json',
+
+  // Outputs
+  out,
+  modulesFileName: 'index',
+  readme: 'none',
 
   // Plugins
   plugin: [
@@ -20,14 +38,11 @@ const app = await Application.bootstrapWithPlugins({
   hideBreadcrumbs: true,
   hidePageHeader: true,
   disableSources: true,
-  propertiesFormat: 'table',
-
-  entryFileName: 'index',
-  tsconfig: 'tsconfig.json',
 });
 
 const project = await app.convert();
 
 if (project) {
+  rmSync(out, { recursive: true, force: true });
   await app.generateOutputs(project);
 }

package-lock.json

@@ -0,0 +1,77 @@
+# AggressiveSplitting
+
+<!-- type=misc -->
+
+## `AggressiveSplittingPluginOptions`
+
+### Properties
+
+#### `chunkOverhead`
+
+* Type: {number} Optional.
+
+Extra cost for each chunk (Default: 9.8kiB).
+
+***
+
+#### `entryChunkMultiplicator`
+
+* Type: {number} Optional.
+
+Extra cost multiplicator for entry chunks (Default: 10).
+
+***
+
+#### `maxSize`
+
+* Type: {number} Optional.
+
+Byte, max size of per file (Default: 50kiB).
+
+***
+
+#### `minSize`
+
+* Type: {number} Optional.
+
+Byte, split point. (Default: 30kiB).
+
+## Class: `AggressiveSplittingPlugin`
+
+### Constructors
+
+#### `new AggressiveSplittingPlugin([options])`
+
+##### Parameters
+
+* `options` {AggressiveSplittingPluginOptions}
+
+* Returns: {AggressiveSplittingPlugin}
+
+### Properties
+
+#### `options`
+
+* Type: {AggressiveSplittingPluginOptions}
+
+### Methods
+
+#### `apply(compiler)`
+
+##### Parameters
+
+* `compiler` {Compiler}
+
+* Returns: {void}
+
+Apply the plugin
+
+***
+
+#### Static method: `wasChunkRecorded(chunk)`
+
+##### Parameters
+
+* `chunk` {Chunk}
+
+* Returns: {boolean}

pages/v5.x/AggressiveSplitting.md

@@ -0,0 +1,29 @@
+# Argument
+
+<!-- type=misc -->
+
+## `Argument`
+
+### Properties
+
+#### `configs`
+
+* Type: {ArgumentConfig[]}
+
+***
+
+#### `description`
+
+* Type: {string} Optional.
+
+***
+
+#### `multiple`
+
+* Type: {boolean}
+
+***
+
+#### `simpleType`
+
+* Type: {SimpleType}

pages/v5.x/Argument.md

@@ -0,0 +1,57 @@
+# Asset
+
+<!-- type=misc -->
+
+## `Asset`
+
+### Properties
+
+#### `info`
+
+* Type: {AssetInfo}
+
+info about the asset
+
+***
+
+#### `name`
+
+* Type: {string}
+
+the filename of the asset
+
+***
+
+#### `source`
+
+* Type: {Source}
+
+source of the asset
+
+## `AssetInfo`
+
+* Type: {KnownAssetInfo & Record<string, any>}
+
+## `AssetEmittedInfo`
+
+### Properties
+
+#### `compilation`
+
+* Type: {Compilation}
+
+#### `content`
+
+* Type: {Buffer}
+
+#### `outputPath`
+
+* Type: {string}
+
+#### `source`
+
+* Type: {Source}
+
+#### `targetPath`
+
+* Type: {string}

pages/v5.x/Asset.md

@@ -0,0 +1,163 @@
+# AsyncDependenciesBlock
+
+<!-- type=misc -->
+
+## Class: `AsyncDependenciesBlock`
+
+* Extends: {DependenciesBlock}
+
+### Constructors
+
+#### `new AsyncDependenciesBlock(groupOptions[, loc][, request])`
+
+##### Parameters
+
+* `groupOptions` {string|GroupOptionsAsyncDependenciesBlock}
+* `loc` {SyntheticDependencyLocation|RealDependencyLocation}
+* `request` {string}
+
+* Returns: {AsyncDependenciesBlock}
+
+### Properties
+
+#### `blocks`
+
+* Type: {AsyncDependenciesBlock[]}
+
+##### Inherited from
+
+`DependenciesBlock.blocks`
+
+***
+
+#### `chunkName`
+
+* Type: {string} Optional.
+
+***
+
+#### `circular`
+
+* Type: {boolean}
+
+***
+
+#### `dependencies`
+
+* Type: {Dependency[]}
+
+##### Inherited from
+
+`DependenciesBlock.dependencies`
+
+***
+
+#### `groupOptions`
+
+* Type: {GroupOptionsAsyncDependenciesBlock}
+
+***
+
+#### `loc`
+
+* Type: {SyntheticDependencyLocation|RealDependencyLocation} Optional.
+
+***
+
+#### `module`
+
+* Type: {any}
+
+***
+
+#### `parent`
+
+* Type: {DependenciesBlock} Optional.
+
+##### Inherited from
+
+`DependenciesBlock.parent`
+
+***
+
+#### `request`
+
+* Type: {string} Optional.
+
+### Methods
+
+#### `addBlock(block)`
+
+##### Parameters
+
+* `block` {AsyncDependenciesBlock}
+
+* Returns: {void}
+
+Adds a DependencyBlock to DependencyBlock relationship.
+This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting)
+
+***
+
+#### `addDependency(dependency)`
+
+##### Parameters
+
+* `dependency` {Dependency}
+
+* Returns: {void}
+
+***
+
+#### `clearDependenciesAndBlocks()`
+
+* Returns: {void}
+
+Removes all dependencies and blocks
+
+***
+
+#### `deserialize(__namedParameters)`
+
+##### Parameters
+
+* `__namedParameters` {ObjectDeserializerContext}
+
+* Returns: {void}
+
+***
+
+#### `getRootBlock()`
+
+* Returns: {DependenciesBlock}
+
+***
+
+#### `removeDependency(dependency)`
+
+##### Parameters
+
+* `dependency` {Dependency}
+
+* Returns: {void}
+
+***
+
+#### `serialize(__namedParameters)`
+
+##### Parameters
+
+* `__namedParameters` {ObjectSerializerContext}
+
+* Returns: {void}
+
+***
+
+#### `updateHash(hash, context)`
+
+##### Parameters
+
+* `hash` {Hash}
+* `context` {UpdateHashContextDependency}
+
+* Returns: {void}