From 40482423b7ee184bc3dcd55a83fb396aae0ae917 Mon Sep 17 00:00:00 2001 From: Katari Date: Fri, 13 Mar 2026 10:22:57 +0530 Subject: [PATCH 1/2] feat(typedoc): treat accessor reflections as properties --- pages/v5.x/globals.md | 1101 ++--------------- pages/v5.x/webpack/namespaces/dependencies.md | 188 +-- pages/v5.x/webpack/namespaces/esm.md | 184 +-- pages/v5.x/webpack/namespaces/runtime.md | 368 +----- pages/v5.x/webpack/namespaces/util/index.md | 12 +- .../namespaces/util/namespaces/runtime.md | 24 +- pages/v5.x/webpack/namespaces/web.md | 368 +----- plugins/processor.mjs | 13 + 8 files changed, 181 insertions(+), 2077 deletions(-) diff --git a/pages/v5.x/globals.md b/pages/v5.x/globals.md index ec120c0..60dd0be 100644 --- a/pages/v5.x/globals.md +++ b/pages/v5.x/globals.md @@ -48,6 +48,7 @@ * `blocks` {AsyncDependenciesBlock[]} * `chunkName` {string} +* `circular` {boolean} * `dependencies` {Dependency[]} * `groupOptions` {GroupOptionsAsyncDependenciesBlock} * `loc` {SyntheticDependencyLocation|RealDependencyLocation} @@ -55,18 +56,6 @@ * `parent` {DependenciesBlock} * `request` {string} -### Accessors - -#### Accessor: `circular` - -##### Get Signature - -> **get** **circular**(): {boolean} - -###### Returns - -{boolean} - ### Methods #### `addBlock(block)` @@ -243,53 +232,22 @@ After this method has succeeded the cache can only be restored when build depend * `contentHash` {Record} * `cssFilenameTemplate` {string|object} * `debugId` {number} +* `entryModule` {Module} * `extraAsync` {boolean} * `filenameTemplate` {string|object} * `files` {Set} +* `groupsIterable` {SortableSet} * `hash` {string} * `id` {string|number} * `idNameHints` {SortableSet} * `ids` {ChunkId[]} +* `modulesIterable` {Iterable} * `name` {string} * `preventIntegration` {boolean} * `rendered` {boolean} * `renderedHash` {string} * `runtime` {RuntimeSpec} -### Accessors - -#### Accessor: `entryModule` - -##### Get Signature - -> **get** **entryModule**(): {Module} - -###### Deprecated - -###### Returns - -{Module} - -#### Accessor: `groupsIterable` - -##### Get Signature - -> **get** **groupsIterable**(): {SortableSet} - -###### Returns - -{SortableSet} - -#### Accessor: `modulesIterable` - -##### Get Signature - -> **get** **modulesIterable**(): {Iterable} - -###### Returns - -{Iterable} - ### Methods #### `addGroup(chunkGroup)` @@ -1019,81 +977,21 @@ After this method has succeeded the cache can only be restored when build depend ### Properties +* `asyncEntrypointsIterable` {SortableSet} +* `blocksIterable` {Iterable} +* `childrenIterable` {SortableSet} * `chunks` {Chunk[]} +* `debugId` {string} get a uniqueId for ChunkGroup, made up of its member Chunk debugId's * `getModuleIndex` {object} * `getModuleIndex2` {object} * `groupDebugId` {number} +* `id` {string} get a unique id for ChunkGroup, made up of its member Chunk id's * `index` {number} * `name` {string} returns the name of current ChunkGroup sets a new name for current ChunkGroup * `options` {ChunkGroupOptions} * `origins` {OriginRecord[]} - -### Accessors - -#### Accessor: `asyncEntrypointsIterable` - -##### Get Signature - -> **get** **asyncEntrypointsIterable**(): {SortableSet} - -###### Returns - -{SortableSet} - -#### Accessor: `blocksIterable` - -##### Get Signature - -> **get** **blocksIterable**(): {Iterable} - -###### Returns - -{Iterable} - -#### Accessor: `childrenIterable` - -##### Get Signature - -> **get** **childrenIterable**(): {SortableSet} - -###### Returns - -{SortableSet} - -#### Accessor: `debugId` - -##### Get Signature - -> **get** **debugId**(): {string} - -get a uniqueId for ChunkGroup, made up of its member Chunk debugId's - -###### Returns - -{string} - -#### Accessor: `id` - -##### Get Signature - -> **get** **id**(): {string} - -get a unique id for ChunkGroup, made up of its member Chunk id's - -###### Returns - -{string} - -#### Accessor: `parentsIterable` - -##### Get Signature - -> **get** **parentsIterable**(): {SortableSet} - -###### Returns - -{SortableSet} +* `parentsIterable` {SortableSet} ### Methods @@ -2180,46 +2078,17 @@ Apply the plugin ### Properties +* `category` {string} +* `disconnect` {any} * `loc` {DependencyLocation} * `module` {any} * `optional` {boolean} +* `type` {string} * `weak` {boolean} * `EXPORTS_OBJECT_REFERENCED` {string[][]} * `NO_EXPORTS_REFERENCED` {string[][]} * `TRANSITIVE` {TRANSITIVE} -### Accessors - -#### Accessor: `category` - -##### Get Signature - -> **get** **category**(): {string} - -###### Returns - -{string} - -#### Accessor: `disconnect` - -##### Get Signature - -> **get** **disconnect**(): {any} - -###### Returns - -{any} - -#### Accessor: `type` - -##### Get Signature - -> **get** **type**(): {string} - -###### Returns - -{string} - ### Methods #### `couldAffectReferencingModule()` @@ -2503,105 +2372,21 @@ Apply the plugin ### Properties +* `asyncEntrypointsIterable` {SortableSet} +* `blocksIterable` {Iterable} +* `childrenIterable` {SortableSet} * `chunks` {Chunk[]} +* `debugId` {string} get a uniqueId for ChunkGroup, made up of its member Chunk debugId's * `getModuleIndex` {object} * `getModuleIndex2` {object} * `groupDebugId` {number} +* `id` {string} get a unique id for ChunkGroup, made up of its member Chunk id's * `index` {number} * `name` {string} returns the name of current ChunkGroup sets a new name for current ChunkGroup * `options` {ChunkGroupOptions} * `origins` {OriginRecord[]} - -### Accessors - -#### Accessor: `asyncEntrypointsIterable` - -##### Get Signature - -> **get** **asyncEntrypointsIterable**(): {SortableSet} - -###### Returns - -{SortableSet} - -##### Inherited from - -[`ChunkGroup`](#abstract-chunkgroup).[`asyncEntrypointsIterable`](#asyncentrypointsiterable) - -#### Accessor: `blocksIterable` - -##### Get Signature - -> **get** **blocksIterable**(): {Iterable} - -###### Returns - -{Iterable} - -##### Inherited from - -[`ChunkGroup`](#abstract-chunkgroup).[`blocksIterable`](#blocksiterable) - -#### Accessor: `childrenIterable` - -##### Get Signature - -> **get** **childrenIterable**(): {SortableSet} - -###### Returns - -{SortableSet} - -##### Inherited from - -[`ChunkGroup`](#abstract-chunkgroup).[`childrenIterable`](#childreniterable) - -#### Accessor: `debugId` - -##### Get Signature - -> **get** **debugId**(): {string} - -get a uniqueId for ChunkGroup, made up of its member Chunk debugId's - -###### Returns - -{string} - -##### Inherited from - -[`ChunkGroup`](#abstract-chunkgroup).[`debugId`](#debugid-1) - -#### Accessor: `id` - -##### Get Signature - -> **get** **id**(): {string} - -get a unique id for ChunkGroup, made up of its member Chunk id's - -###### Returns - -{string} - -##### Inherited from - -[`ChunkGroup`](#abstract-chunkgroup).[`id`](#id-1) - -#### Accessor: `parentsIterable` - -##### Get Signature - -> **get** **parentsIterable**(): {SortableSet} - -###### Returns - -{SortableSet} - -##### Inherited from - -[`ChunkGroup`](#abstract-chunkgroup).[`parentsIterable`](#parentsiterable) +* `parentsIterable` {SortableSet} ### Methods @@ -2919,206 +2704,46 @@ Apply the plugin * `blocks` {AsyncDependenciesBlock[]} * `buildInfo` {BuildInfo} * `buildMeta` {BuildMeta} +* `chunksIterable` {Iterable} * `codeGenerationDependencies` {Dependency[]} * `context` {string} * `debugId` {number} * `dependencies` {Dependency[]} * `dependencyMeta` {ImportDependencyMeta|CssImportDependencyMeta|AssetDependencyMeta} * `depth` {number} +* `errors` {any} +* `exportsArgument` {string} * `externalType` {ExternalsType} * `factoryMeta` {FactoryMeta} +* `hasEqualsChunks` {any} +* `hash` {string} * `hot` {boolean} * `id` {string|number} * `index` {number} * `index2` {number} * `issuer` {Module} +* `isUsed` {any} * `layer` {string} +* `moduleArgument` {string} * `needId` {boolean} +* `optimizationBailout` {string|object[]} +* `optional` {boolean} * `parent` {DependenciesBlock} * `presentationalDependencies` {Dependency[]} * `profile` {ModuleProfile} +* `renderedHash` {string} * `request` {ExternalModuleRequest} * `resolveOptions` {ResolveOptions} * `type` {string} * `used` {any} +* `usedExports` {boolean|SortableSet} * `userRequest` {string} * `useSimpleSourceMap` {boolean} * `useSourceMap` {boolean} +* `warnings` {any} * `getExternalModuleNodeCommonjsInitFragment` {object} * `ModuleExternalInitFragment` {ModuleExternalInitFragment} -### Accessors - -#### Accessor: `chunksIterable` - -##### Get Signature - -> **get** **chunksIterable**(): {Iterable} - -###### Returns - -{Iterable} - -##### Inherited from - -[`Module`](#module-2).[`chunksIterable`](#chunksiterable-1) - -#### Accessor: `errors` - -##### Get Signature - -> **get** **errors**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`Module`](#module-2).[`errors`](#errors-2) - -#### Accessor: `exportsArgument` - -##### Get Signature - -> **get** **exportsArgument**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`Module`](#module-2).[`exportsArgument`](#exportsargument-1) - -#### Accessor: `hasEqualsChunks` - -##### Get Signature - -> **get** **hasEqualsChunks**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`Module`](#module-2).[`hasEqualsChunks`](#hasequalschunks-1) - -#### Accessor: `hash` - -##### Get Signature - -> **get** **hash**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`Module`](#module-2).[`hash`](#hash-4) - -#### Accessor: `isUsed` - -##### Get Signature - -> **get** **isUsed**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`Module`](#module-2).[`isUsed`](#isused-1) - -#### Accessor: `moduleArgument` - -##### Get Signature - -> **get** **moduleArgument**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`Module`](#module-2).[`moduleArgument`](#moduleargument-1) - -#### Accessor: `optimizationBailout` - -##### Get Signature - -> **get** **optimizationBailout**(): {string|object[]} - -###### Deprecated - -###### Returns - -{string|object[]} - -##### Inherited from - -[`Module`](#module-2).[`optimizationBailout`](#optimizationbailout-1) - -#### Accessor: `optional` - -##### Get Signature - -> **get** **optional**(): {boolean} - -###### Returns - -{boolean} - -##### Inherited from - -[`Module`](#module-2).[`optional`](#optional-2) - -#### Accessor: `renderedHash` - -##### Get Signature - -> **get** **renderedHash**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`Module`](#module-2).[`renderedHash`](#renderedhash-3) - -#### Accessor: `usedExports` - -##### Get Signature - -> **get** **usedExports**(): {boolean|SortableSet} - -###### Returns - -{boolean|SortableSet} - -##### Inherited from - -[`Module`](#module-2).[`usedExports`](#usedexports-1) - -#### Accessor: `warnings` - -##### Get Signature - -> **get** **warnings**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`Module`](#module-2).[`warnings`](#warnings-2) - ### Methods #### `addBlock(block)` @@ -3547,65 +3172,22 @@ Apply the plugin * `contentHash` {Record} * `cssFilenameTemplate` {string|object} * `debugId` {number} +* `entryModule` {Module} * `extraAsync` {boolean} * `filenameTemplate` {string|object} * `files` {Set} +* `groupsIterable` {SortableSet} * `hash` {string} * `id` {string|number} * `idNameHints` {SortableSet} * `ids` {ChunkId[]} +* `modulesIterable` {Iterable} * `name` {string} * `preventIntegration` {boolean} * `rendered` {boolean} * `renderedHash` {string} * `runtime` {RuntimeSpec} -### Accessors - -#### Accessor: `entryModule` - -##### Get Signature - -> **get** **entryModule**(): {Module} - -###### Deprecated - -###### Returns - -{Module} - -##### Inherited from - -[`Chunk`](#chunk).[`entryModule`](#entrymodule) - -#### Accessor: `groupsIterable` - -##### Get Signature - -> **get** **groupsIterable**(): {SortableSet} - -###### Returns - -{SortableSet} - -##### Inherited from - -[`Chunk`](#chunk).[`groupsIterable`](#groupsiterable) - -#### Accessor: `modulesIterable` - -##### Get Signature - -> **get** **modulesIterable**(): {Iterable} - -###### Returns - -{Iterable} - -##### Inherited from - -[`Chunk`](#chunk).[`modulesIterable`](#modulesiterable) - ### Methods #### `addGroup(chunkGroup)` @@ -4123,171 +3705,59 @@ Apply the plugin * `blocks` {AsyncDependenciesBlock[]} * `buildInfo` {BuildInfo} * `buildMeta` {BuildMeta} +* `chunksIterable` {Iterable} * `codeGenerationDependencies` {Dependency[]} * `context` {string} * `debugId` {number} * `dependencies` {Dependency[]} * `depth` {number} +* `errors` {any} +* `exportsArgument` {string} * `factoryMeta` {FactoryMeta} +* `hasEqualsChunks` {any} +* `hash` {string} * `hot` {boolean} * `id` {string|number} * `index` {number} * `index2` {number} * `issuer` {Module} +* `isUsed` {any} * `layer` {string} +* `moduleArgument` {string} * `needId` {boolean} +* `optimizationBailout` {string|object[]} +* `optional` {boolean} * `parent` {DependenciesBlock} * `presentationalDependencies` {Dependency[]} * `profile` {ModuleProfile} +* `renderedHash` {string} * `resolveOptions` {ResolveOptions} * `type` {string} * `used` {any} +* `usedExports` {boolean|SortableSet} * `useSimpleSourceMap` {boolean} * `useSourceMap` {boolean} +* `warnings` {any} -### Accessors +### Methods -#### Accessor: `chunksIterable` +#### `addBlock(block)` -##### Get Signature +* `block` {AsyncDependenciesBlock} +* Returns: {void} -> **get** **chunksIterable**(): {Iterable} +Adds a DependencyBlock to DependencyBlock relationship. +This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting) -###### Returns +#### `addCacheDependencies(fileDependencies, contextDependencies, missingDependencies, buildDependencies)` -{Iterable} +* `fileDependencies` {LazySet} +* `contextDependencies` {LazySet} +* `missingDependencies` {LazySet} +* `buildDependencies` {LazySet} +* Returns: {void} -#### Accessor: `errors` - -##### Get Signature - -> **get** **errors**(): {any} - -###### Returns - -{any} - -#### Accessor: `exportsArgument` - -##### Get Signature - -> **get** **exportsArgument**(): {string} - -###### Returns - -{string} - -#### Accessor: `hasEqualsChunks` - -##### Get Signature - -> **get** **hasEqualsChunks**(): {any} - -###### Returns - -{any} - -#### Accessor: `hash` - -##### Get Signature - -> **get** **hash**(): {string} - -###### Returns - -{string} - -#### Accessor: `isUsed` - -##### Get Signature - -> **get** **isUsed**(): {any} - -###### Returns - -{any} - -#### Accessor: `moduleArgument` - -##### Get Signature - -> **get** **moduleArgument**(): {string} - -###### Returns - -{string} - -#### Accessor: `optimizationBailout` - -##### Get Signature - -> **get** **optimizationBailout**(): {string|object[]} - -###### Deprecated - -###### Returns - -{string|object[]} - -#### Accessor: `optional` - -##### Get Signature - -> **get** **optional**(): {boolean} - -###### Returns - -{boolean} - -#### Accessor: `renderedHash` - -##### Get Signature - -> **get** **renderedHash**(): {string} - -###### Returns - -{string} - -#### Accessor: `usedExports` - -##### Get Signature - -> **get** **usedExports**(): {boolean|SortableSet} - -###### Returns - -{boolean|SortableSet} - -#### Accessor: `warnings` - -##### Get Signature - -> **get** **warnings**(): {any} - -###### Returns - -{any} - -### Methods - -#### `addBlock(block)` - -* `block` {AsyncDependenciesBlock} -* Returns: {void} - -Adds a DependencyBlock to DependencyBlock relationship. -This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting) - -#### `addCacheDependencies(fileDependencies, contextDependencies, missingDependencies, buildDependencies)` - -* `fileDependencies` {LazySet} -* `contextDependencies` {LazySet} -* `missingDependencies` {LazySet} -* `buildDependencies` {LazySet} -* Returns: {void} - -#### `addChunk(chunk)` +#### `addChunk(chunk)` * `chunk` {Chunk} * Returns: {boolean} @@ -4982,6 +4452,7 @@ In webpack 6, call getSourceBasicTypes() directly on the module instance instead * `condition` {false|object} * `conditional` {boolean} * `dependency` {Dependency} +* `explanation` {string} * `explanations` {Set} * `module` {Module} * `originModule` {Module} @@ -4992,18 +4463,6 @@ In webpack 6, call getSourceBasicTypes() directly on the module instance instead * `CIRCULAR_CONNECTION` {CIRCULAR_CONNECTION} * `TRANSITIVE_ONLY` {TRANSITIVE_ONLY} -### Accessors - -#### Accessor: `explanation` - -##### Get Signature - -> **get** **explanation**(): {string} - -###### Returns - -{string} - ### Methods #### `addCondition(condition)` @@ -5059,32 +4518,12 @@ In webpack 6, call getSourceBasicTypes() directly on the module instance instead * `hooks` {Readonly} * `inputFileSystem` {InputFileSystem} * `intermediateFileSystem` {IntermediateFileSystem} +* `options` {WebpackOptionsNormalized[]|MultiCompilerOptions} * `outputFileSystem` {OutputFileSystem} +* `outputPath` {string} * `running` {boolean} * `watchFileSystem` {WatchFileSystem} -### Accessors - -#### Accessor: `options` - -##### Get Signature - -> **get** **options**(): {WebpackOptionsNormalized[]|MultiCompilerOptions} - -###### Returns - -{WebpackOptionsNormalized[]|MultiCompilerOptions} - -#### Accessor: `outputPath` - -##### Get Signature - -> **get** **outputPath**(): {string} - -###### Returns - -{string} - ### Methods #### `close(callback)` @@ -5146,20 +4585,9 @@ This method should have been private ### Properties +* `hash` {string} * `stats` {Stats[]} -### Accessors - -#### Accessor: `hash` - -##### Get Signature - -> **get** **hash**(): {string} - -###### Returns - -{string} - ### Methods #### `hasErrors()` @@ -5220,212 +4648,52 @@ Apply the plugin * `blocks` {AsyncDependenciesBlock[]} * `buildInfo` {BuildInfo} * `buildMeta` {BuildMeta} +* `chunksIterable` {Iterable} * `codeGenerationDependencies` {Dependency[]} * `context` {string} * `debugId` {number} * `dependencies` {Dependency[]} * `depth` {number} * `error` {WebpackError} +* `errors` {any} +* `exportsArgument` {string} * `extractSourceMap` {boolean} * `factoryMeta` {FactoryMeta} * `generator` {Generator} * `generatorOptions` {GeneratorOptions} +* `hasEqualsChunks` {any} +* `hash` {string} * `hot` {boolean} * `id` {string|number} * `index` {number} * `index2` {number} * `issuer` {Module} +* `isUsed` {any} * `layer` {string} * `loaders` {LoaderItem[]} * `matchResource` {string} +* `moduleArgument` {string} * `needId` {boolean} +* `optimizationBailout` {string|object[]} +* `optional` {boolean} * `parent` {DependenciesBlock} * `parser` {ParserClass} * `parserOptions` {ParserOptions} * `presentationalDependencies` {Dependency[]} * `profile` {ModuleProfile} * `rawRequest` {string} +* `renderedHash` {string} * `request` {string} * `resolveOptions` {ResolveOptions} * `resource` {string} * `resourceResolveData` {ResourceSchemeData|Partial} * `type` {string} * `used` {any} +* `usedExports` {boolean|SortableSet} * `userRequest` {string} * `useSimpleSourceMap` {boolean} * `useSourceMap` {boolean} - -### Accessors - -#### Accessor: `chunksIterable` - -##### Get Signature - -> **get** **chunksIterable**(): {Iterable} - -###### Returns - -{Iterable} - -##### Inherited from - -[`Module`](#module-2).[`chunksIterable`](#chunksiterable-1) - -#### Accessor: `errors` - -##### Get Signature - -> **get** **errors**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`Module`](#module-2).[`errors`](#errors-2) - -#### Accessor: `exportsArgument` - -##### Get Signature - -> **get** **exportsArgument**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`Module`](#module-2).[`exportsArgument`](#exportsargument-1) - -#### Accessor: `hasEqualsChunks` - -##### Get Signature - -> **get** **hasEqualsChunks**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`Module`](#module-2).[`hasEqualsChunks`](#hasequalschunks-1) - -#### Accessor: `hash` - -##### Get Signature - -> **get** **hash**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`Module`](#module-2).[`hash`](#hash-4) - -#### Accessor: `isUsed` - -##### Get Signature - -> **get** **isUsed**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`Module`](#module-2).[`isUsed`](#isused-1) - -#### Accessor: `moduleArgument` - -##### Get Signature - -> **get** **moduleArgument**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`Module`](#module-2).[`moduleArgument`](#moduleargument-1) - -#### Accessor: `optimizationBailout` - -##### Get Signature - -> **get** **optimizationBailout**(): {string|object[]} - -###### Deprecated - -###### Returns - -{string|object[]} - -##### Inherited from - -[`Module`](#module-2).[`optimizationBailout`](#optimizationbailout-1) - -#### Accessor: `optional` - -##### Get Signature - -> **get** **optional**(): {boolean} - -###### Returns - -{boolean} - -##### Inherited from - -[`Module`](#module-2).[`optional`](#optional-2) - -#### Accessor: `renderedHash` - -##### Get Signature - -> **get** **renderedHash**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`Module`](#module-2).[`renderedHash`](#renderedhash-3) - -#### Accessor: `usedExports` - -##### Get Signature - -> **get** **usedExports**(): {boolean|SortableSet} - -###### Returns - -{boolean|SortableSet} - -##### Inherited from - -[`Module`](#module-2).[`usedExports`](#usedexports-1) - -#### Accessor: `warnings` - -##### Get Signature - -> **get** **warnings**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`Module`](#module-2).[`warnings`](#warnings-2) +* `warnings` {any} ### Methods @@ -6068,6 +5336,7 @@ Apply the plugin * `buildMeta` {BuildMeta} * `chunk` {Chunk} * `chunkGraph` {ChunkGraph} +* `chunksIterable` {Iterable} * `codeGenerationDependencies` {Dependency[]} * `compilation` {Compilation} * `context` {string} @@ -6075,202 +5344,41 @@ Apply the plugin * `dependencies` {Dependency[]} * `dependentHash` {boolean} * `depth` {number} +* `errors` {any} +* `exportsArgument` {string} * `factoryMeta` {FactoryMeta} * `fullHash` {boolean} +* `hasEqualsChunks` {any} +* `hash` {string} * `hot` {boolean} * `id` {string|number} * `index` {number} * `index2` {number} * `issuer` {Module} +* `isUsed` {any} * `layer` {string} +* `moduleArgument` {string} * `name` {string} * `needId` {boolean} +* `optimizationBailout` {string|object[]} +* `optional` {boolean} * `parent` {DependenciesBlock} * `presentationalDependencies` {Dependency[]} * `profile` {ModuleProfile} +* `renderedHash` {string} * `resolveOptions` {ResolveOptions} * `stage` {number} * `type` {string} * `used` {any} +* `usedExports` {boolean|SortableSet} * `useSimpleSourceMap` {boolean} * `useSourceMap` {boolean} +* `warnings` {any} * `STAGE_ATTACH` {number} Runtime modules which attach to handlers of other runtime modules * `STAGE_BASIC` {number} Runtime modules with simple dependencies on other runtime modules * `STAGE_NORMAL` {number} Runtime modules without any dependencies to other runtime modules * `STAGE_TRIGGER` {number} Runtime modules which trigger actions on bootstrap -### Accessors - -#### Accessor: `chunksIterable` - -##### Get Signature - -> **get** **chunksIterable**(): {Iterable} - -###### Returns - -{Iterable} - -##### Inherited from - -[`Module`](#module-2).[`chunksIterable`](#chunksiterable-1) - -#### Accessor: `errors` - -##### Get Signature - -> **get** **errors**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`Module`](#module-2).[`errors`](#errors-2) - -#### Accessor: `exportsArgument` - -##### Get Signature - -> **get** **exportsArgument**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`Module`](#module-2).[`exportsArgument`](#exportsargument-1) - -#### Accessor: `hasEqualsChunks` - -##### Get Signature - -> **get** **hasEqualsChunks**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`Module`](#module-2).[`hasEqualsChunks`](#hasequalschunks-1) - -#### Accessor: `hash` - -##### Get Signature - -> **get** **hash**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`Module`](#module-2).[`hash`](#hash-4) - -#### Accessor: `isUsed` - -##### Get Signature - -> **get** **isUsed**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`Module`](#module-2).[`isUsed`](#isused-1) - -#### Accessor: `moduleArgument` - -##### Get Signature - -> **get** **moduleArgument**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`Module`](#module-2).[`moduleArgument`](#moduleargument-1) - -#### Accessor: `optimizationBailout` - -##### Get Signature - -> **get** **optimizationBailout**(): {string|object[]} - -###### Deprecated - -###### Returns - -{string|object[]} - -##### Inherited from - -[`Module`](#module-2).[`optimizationBailout`](#optimizationbailout-1) - -#### Accessor: `optional` - -##### Get Signature - -> **get** **optional**(): {boolean} - -###### Returns - -{boolean} - -##### Inherited from - -[`Module`](#module-2).[`optional`](#optional-2) - -#### Accessor: `renderedHash` - -##### Get Signature - -> **get** **renderedHash**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`Module`](#module-2).[`renderedHash`](#renderedhash-3) - -#### Accessor: `usedExports` - -##### Get Signature - -> **get** **usedExports**(): {boolean|SortableSet} - -###### Returns - -{boolean|SortableSet} - -##### Inherited from - -[`Module`](#module-2).[`usedExports`](#usedexports-1) - -#### Accessor: `warnings` - -##### Get Signature - -> **get** **warnings**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`Module`](#module-2).[`warnings`](#warnings-2) - ### Methods #### `addBlock(block)` @@ -6636,38 +5744,9 @@ Apply the plugin ### Properties * `compilation` {Compilation} - -### Accessors - -#### Accessor: `endTime` - -##### Get Signature - -> **get** **endTime**(): {number} - -###### Returns - -{number} - -#### Accessor: `hash` - -##### Get Signature - -> **get** **hash**(): {string} - -###### Returns - -{string} - -#### Accessor: `startTime` - -##### Get Signature - -> **get** **startTime**(): {number} - -###### Returns - -{number} +* `endTime` {number} +* `hash` {string} +* `startTime` {number} ### Methods diff --git a/pages/v5.x/webpack/namespaces/dependencies.md b/pages/v5.x/webpack/namespaces/dependencies.md index cf09df8..b762983 100644 --- a/pages/v5.x/webpack/namespaces/dependencies.md +++ b/pages/v5.x/webpack/namespaces/dependencies.md @@ -17,62 +17,21 @@ ### Properties +* `category` {string} +* `disconnect` {any} * `expression` {string} * `loc` {DependencyLocation} * `module` {any} * `optional` {boolean} * `range` {number|number|number} * `runtimeRequirements` {Set} +* `type` {string} * `weak` {boolean} * `EXPORTS_OBJECT_REFERENCED` {string[][]} * `NO_EXPORTS_REFERENCED` {string[][]} * `Template` {ConstDependencyTemplate} * `TRANSITIVE` {TRANSITIVE} -### Accessors - -#### Accessor: `category` - -##### Get Signature - -> **get** **category**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`NullDependency`](#nulldependency).[`category`](#category-3) - -#### Accessor: `disconnect` - -##### Get Signature - -> **get** **disconnect**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`NullDependency`](#nulldependency).[`disconnect`](#disconnect-3) - -#### Accessor: `type` - -##### Get Signature - -> **get** **type**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`NullDependency`](#nulldependency).[`type`](#type-3) - ### Methods #### `couldAffectReferencingModule()` @@ -198,6 +157,8 @@ Update the hash ### Properties * `attributes` {ImportAttributes} +* `category` {string} +* `disconnect` {any} * `loc` {DependencyLocation} * `module` {any} * `optional` {boolean} @@ -205,6 +166,7 @@ Update the hash * `range` {number|number} * `request` {string} * `sourceOrder` {number} +* `type` {string} * `userRequest` {string} * `weak` {boolean} * `ExportPresenceModes` {object} @@ -214,50 +176,6 @@ Update the hash * `Template` {HarmonyImportDependencyTemplate} * `TRANSITIVE` {TRANSITIVE} -### Accessors - -#### Accessor: `category` - -##### Get Signature - -> **get** **category**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`ModuleDependency`](#moduledependency).[`category`](#category-2) - -#### Accessor: `disconnect` - -##### Get Signature - -> **get** **disconnect**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`ModuleDependency`](#moduledependency).[`disconnect`](#disconnect-2) - -#### Accessor: `type` - -##### Get Signature - -> **get** **type**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`ModuleDependency`](#moduledependency).[`type`](#type-2) - ### Methods #### `couldAffectReferencingModule()` @@ -407,12 +325,15 @@ Update the hash ### Properties +* `category` {string} +* `disconnect` {any} * `loc` {DependencyLocation} * `module` {any} * `optional` {boolean} * `range` {number|number} * `request` {string} * `sourceOrder` {number} +* `type` {string} * `userRequest` {string} * `weak` {boolean} * `EXPORTS_OBJECT_REFERENCED` {string[][]} @@ -420,50 +341,6 @@ Update the hash * `Template` {DependencyTemplate} * `TRANSITIVE` {TRANSITIVE} -### Accessors - -#### Accessor: `category` - -##### Get Signature - -> **get** **category**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`Dependency`](../../globals.md#dependency).[`category`](../../globals.md#category) - -#### Accessor: `disconnect` - -##### Get Signature - -> **get** **disconnect**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`Dependency`](../../globals.md#dependency).[`disconnect`](../../globals.md#disconnect) - -#### Accessor: `type` - -##### Get Signature - -> **get** **type**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`Dependency`](../../globals.md#dependency).[`type`](../../globals.md#type) - ### Methods #### `couldAffectReferencingModule()` @@ -588,59 +465,18 @@ Update the hash ### Properties +* `category` {string} +* `disconnect` {any} * `loc` {DependencyLocation} * `module` {any} * `optional` {boolean} +* `type` {string} * `weak` {boolean} * `EXPORTS_OBJECT_REFERENCED` {string[][]} * `NO_EXPORTS_REFERENCED` {string[][]} * `Template` {NullDependencyTemplate} * `TRANSITIVE` {TRANSITIVE} -### Accessors - -#### Accessor: `category` - -##### Get Signature - -> **get** **category**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`Dependency`](../../globals.md#dependency).[`category`](../../globals.md#category) - -#### Accessor: `disconnect` - -##### Get Signature - -> **get** **disconnect**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`Dependency`](../../globals.md#dependency).[`disconnect`](../../globals.md#disconnect) - -#### Accessor: `type` - -##### Get Signature - -> **get** **type**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`Dependency`](../../globals.md#dependency).[`type`](../../globals.md#type) - ### Methods #### `couldAffectReferencingModule()` diff --git a/pages/v5.x/webpack/namespaces/esm.md b/pages/v5.x/webpack/namespaces/esm.md index 509f9a3..feec8a7 100644 --- a/pages/v5.x/webpack/namespaces/esm.md +++ b/pages/v5.x/webpack/namespaces/esm.md @@ -20,6 +20,7 @@ * `buildMeta` {BuildMeta} * `chunk` {Chunk} * `chunkGraph` {ChunkGraph} +* `chunksIterable` {Iterable} * `codeGenerationDependencies` {Dependency[]} * `compilation` {Compilation} * `context` {string} @@ -27,202 +28,41 @@ * `dependencies` {Dependency[]} * `dependentHash` {boolean} * `depth` {number} +* `errors` {any} +* `exportsArgument` {string} * `factoryMeta` {FactoryMeta} * `fullHash` {boolean} +* `hasEqualsChunks` {any} +* `hash` {string} * `hot` {boolean} * `id` {string|number} * `index` {number} * `index2` {number} * `issuer` {Module} +* `isUsed` {any} * `layer` {string} +* `moduleArgument` {string} * `name` {string} * `needId` {boolean} +* `optimizationBailout` {string|object[]} +* `optional` {boolean} * `parent` {DependenciesBlock} * `presentationalDependencies` {Dependency[]} * `profile` {ModuleProfile} +* `renderedHash` {string} * `resolveOptions` {ResolveOptions} * `stage` {number} * `type` {string} * `used` {any} +* `usedExports` {boolean|SortableSet} * `useSimpleSourceMap` {boolean} * `useSourceMap` {boolean} +* `warnings` {any} * `STAGE_ATTACH` {number} Runtime modules which attach to handlers of other runtime modules * `STAGE_BASIC` {number} Runtime modules with simple dependencies on other runtime modules * `STAGE_NORMAL` {number} Runtime modules without any dependencies to other runtime modules * `STAGE_TRIGGER` {number} Runtime modules which trigger actions on bootstrap -### Accessors - -#### Accessor: `chunksIterable` - -##### Get Signature - -> **get** **chunksIterable**(): {Iterable} - -###### Returns - -{Iterable} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`chunksIterable`](../../globals.md#chunksiterable-3) - -#### Accessor: `errors` - -##### Get Signature - -> **get** **errors**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`errors`](../../globals.md#errors-4) - -#### Accessor: `exportsArgument` - -##### Get Signature - -> **get** **exportsArgument**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`exportsArgument`](../../globals.md#exportsargument-3) - -#### Accessor: `hasEqualsChunks` - -##### Get Signature - -> **get** **hasEqualsChunks**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`hasEqualsChunks`](../../globals.md#hasequalschunks-3) - -#### Accessor: `hash` - -##### Get Signature - -> **get** **hash**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`hash`](../../globals.md#hash-7) - -#### Accessor: `isUsed` - -##### Get Signature - -> **get** **isUsed**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`isUsed`](../../globals.md#isused-3) - -#### Accessor: `moduleArgument` - -##### Get Signature - -> **get** **moduleArgument**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`moduleArgument`](../../globals.md#moduleargument-3) - -#### Accessor: `optimizationBailout` - -##### Get Signature - -> **get** **optimizationBailout**(): {string|object[]} - -###### Deprecated - -###### Returns - -{string|object[]} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`optimizationBailout`](../../globals.md#optimizationbailout-3) - -#### Accessor: `optional` - -##### Get Signature - -> **get** **optional**(): {boolean} - -###### Returns - -{boolean} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`optional`](../../globals.md#optional-4) - -#### Accessor: `renderedHash` - -##### Get Signature - -> **get** **renderedHash**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`renderedHash`](../../globals.md#renderedhash-5) - -#### Accessor: `usedExports` - -##### Get Signature - -> **get** **usedExports**(): {boolean|SortableSet} - -###### Returns - -{boolean|SortableSet} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`usedExports`](../../globals.md#usedexports-3) - -#### Accessor: `warnings` - -##### Get Signature - -> **get** **warnings**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`warnings`](../../globals.md#warnings-4) - ### Methods #### `addBlock(block)` diff --git a/pages/v5.x/webpack/namespaces/runtime.md b/pages/v5.x/webpack/namespaces/runtime.md index 29075ca..9c4fc0e 100644 --- a/pages/v5.x/webpack/namespaces/runtime.md +++ b/pages/v5.x/webpack/namespaces/runtime.md @@ -25,6 +25,7 @@ * `buildMeta` {BuildMeta} * `chunk` {Chunk} * `chunkGraph` {ChunkGraph} +* `chunksIterable` {Iterable} * `codeGenerationDependencies` {Dependency[]} * `compilation` {Compilation} * `contentType` {string} @@ -33,204 +34,43 @@ * `dependencies` {Dependency[]} * `dependentHash` {boolean} * `depth` {number} +* `errors` {any} +* `exportsArgument` {string} * `factoryMeta` {FactoryMeta} * `fullHash` {boolean} * `getFilenameForChunk` {object} * `global` {string} +* `hasEqualsChunks` {any} +* `hash` {string} * `hot` {boolean} * `id` {string|number} * `index` {number} * `index2` {number} * `issuer` {Module} +* `isUsed` {any} * `layer` {string} +* `moduleArgument` {string} * `name` {string} * `needId` {boolean} +* `optimizationBailout` {string|object[]} +* `optional` {boolean} * `parent` {DependenciesBlock} * `presentationalDependencies` {Dependency[]} * `profile` {ModuleProfile} +* `renderedHash` {string} * `resolveOptions` {ResolveOptions} * `stage` {number} * `type` {string} * `used` {any} +* `usedExports` {boolean|SortableSet} * `useSimpleSourceMap` {boolean} * `useSourceMap` {boolean} +* `warnings` {any} * `STAGE_ATTACH` {number} Runtime modules which attach to handlers of other runtime modules * `STAGE_BASIC` {number} Runtime modules with simple dependencies on other runtime modules * `STAGE_NORMAL` {number} Runtime modules without any dependencies to other runtime modules * `STAGE_TRIGGER` {number} Runtime modules which trigger actions on bootstrap -### Accessors - -#### Accessor: `chunksIterable` - -##### Get Signature - -> **get** **chunksIterable**(): {Iterable} - -###### Returns - -{Iterable} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`chunksIterable`](../../globals.md#chunksiterable-3) - -#### Accessor: `errors` - -##### Get Signature - -> **get** **errors**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`errors`](../../globals.md#errors-4) - -#### Accessor: `exportsArgument` - -##### Get Signature - -> **get** **exportsArgument**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`exportsArgument`](../../globals.md#exportsargument-3) - -#### Accessor: `hasEqualsChunks` - -##### Get Signature - -> **get** **hasEqualsChunks**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`hasEqualsChunks`](../../globals.md#hasequalschunks-3) - -#### Accessor: `hash` - -##### Get Signature - -> **get** **hash**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`hash`](../../globals.md#hash-7) - -#### Accessor: `isUsed` - -##### Get Signature - -> **get** **isUsed**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`isUsed`](../../globals.md#isused-3) - -#### Accessor: `moduleArgument` - -##### Get Signature - -> **get** **moduleArgument**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`moduleArgument`](../../globals.md#moduleargument-3) - -#### Accessor: `optimizationBailout` - -##### Get Signature - -> **get** **optimizationBailout**(): {string|object[]} - -###### Deprecated - -###### Returns - -{string|object[]} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`optimizationBailout`](../../globals.md#optimizationbailout-3) - -#### Accessor: `optional` - -##### Get Signature - -> **get** **optional**(): {boolean} - -###### Returns - -{boolean} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`optional`](../../globals.md#optional-4) - -#### Accessor: `renderedHash` - -##### Get Signature - -> **get** **renderedHash**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`renderedHash`](../../globals.md#renderedhash-5) - -#### Accessor: `usedExports` - -##### Get Signature - -> **get** **usedExports**(): {boolean|SortableSet} - -###### Returns - -{boolean|SortableSet} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`usedExports`](../../globals.md#usedexports-3) - -#### Accessor: `warnings` - -##### Get Signature - -> **get** **warnings**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`warnings`](../../globals.md#warnings-4) - ### Methods #### `addBlock(block)` @@ -576,6 +416,7 @@ In webpack 6, call getSourceBasicTypes() directly on the module instance instead * `buildMeta` {BuildMeta} * `chunk` {Chunk} * `chunkGraph` {ChunkGraph} +* `chunksIterable` {Iterable} * `codeGenerationDependencies` {Dependency[]} * `compilation` {Compilation} * `context` {string} @@ -583,202 +424,41 @@ In webpack 6, call getSourceBasicTypes() directly on the module instance instead * `dependencies` {Dependency[]} * `dependentHash` {boolean} * `depth` {number} +* `errors` {any} +* `exportsArgument` {string} * `factoryMeta` {FactoryMeta} * `fullHash` {boolean} +* `hasEqualsChunks` {any} +* `hash` {string} * `hot` {boolean} * `id` {string|number} * `index` {number} * `index2` {number} * `issuer` {Module} +* `isUsed` {any} * `layer` {string} +* `moduleArgument` {string} * `name` {string} * `needId` {boolean} +* `optimizationBailout` {string|object[]} +* `optional` {boolean} * `parent` {DependenciesBlock} * `presentationalDependencies` {Dependency[]} * `profile` {ModuleProfile} +* `renderedHash` {string} * `resolveOptions` {ResolveOptions} * `stage` {number} * `type` {string} * `used` {any} +* `usedExports` {boolean|SortableSet} * `useSimpleSourceMap` {boolean} * `useSourceMap` {boolean} +* `warnings` {any} * `STAGE_ATTACH` {number} Runtime modules which attach to handlers of other runtime modules * `STAGE_BASIC` {number} Runtime modules with simple dependencies on other runtime modules * `STAGE_NORMAL` {number} Runtime modules without any dependencies to other runtime modules * `STAGE_TRIGGER` {number} Runtime modules which trigger actions on bootstrap -### Accessors - -#### Accessor: `chunksIterable` - -##### Get Signature - -> **get** **chunksIterable**(): {Iterable} - -###### Returns - -{Iterable} - -##### Inherited from - -`HelperRuntimeModule.chunksIterable` - -#### Accessor: `errors` - -##### Get Signature - -> **get** **errors**(): {any} - -###### Returns - -{any} - -##### Inherited from - -`HelperRuntimeModule.errors` - -#### Accessor: `exportsArgument` - -##### Get Signature - -> **get** **exportsArgument**(): {string} - -###### Returns - -{string} - -##### Inherited from - -`HelperRuntimeModule.exportsArgument` - -#### Accessor: `hasEqualsChunks` - -##### Get Signature - -> **get** **hasEqualsChunks**(): {any} - -###### Returns - -{any} - -##### Inherited from - -`HelperRuntimeModule.hasEqualsChunks` - -#### Accessor: `hash` - -##### Get Signature - -> **get** **hash**(): {string} - -###### Returns - -{string} - -##### Inherited from - -`HelperRuntimeModule.hash` - -#### Accessor: `isUsed` - -##### Get Signature - -> **get** **isUsed**(): {any} - -###### Returns - -{any} - -##### Inherited from - -`HelperRuntimeModule.isUsed` - -#### Accessor: `moduleArgument` - -##### Get Signature - -> **get** **moduleArgument**(): {string} - -###### Returns - -{string} - -##### Inherited from - -`HelperRuntimeModule.moduleArgument` - -#### Accessor: `optimizationBailout` - -##### Get Signature - -> **get** **optimizationBailout**(): {string|object[]} - -###### Deprecated - -###### Returns - -{string|object[]} - -##### Inherited from - -`HelperRuntimeModule.optimizationBailout` - -#### Accessor: `optional` - -##### Get Signature - -> **get** **optional**(): {boolean} - -###### Returns - -{boolean} - -##### Inherited from - -`HelperRuntimeModule.optional` - -#### Accessor: `renderedHash` - -##### Get Signature - -> **get** **renderedHash**(): {string} - -###### Returns - -{string} - -##### Inherited from - -`HelperRuntimeModule.renderedHash` - -#### Accessor: `usedExports` - -##### Get Signature - -> **get** **usedExports**(): {boolean|SortableSet} - -###### Returns - -{boolean|SortableSet} - -##### Inherited from - -`HelperRuntimeModule.usedExports` - -#### Accessor: `warnings` - -##### Get Signature - -> **get** **warnings**(): {any} - -###### Returns - -{any} - -##### Inherited from - -`HelperRuntimeModule.warnings` - ### Methods #### `addBlock(block)` diff --git a/pages/v5.x/webpack/namespaces/util/index.md b/pages/v5.x/webpack/namespaces/util/index.md index df46e58..c514633 100644 --- a/pages/v5.x/webpack/namespaces/util/index.md +++ b/pages/v5.x/webpack/namespaces/util/index.md @@ -25,17 +25,9 @@ * `iterable` {Iterable} * Returns: {LazySet} -### Accessors +### Properties -#### Accessor: `size` - -##### Get Signature - -> **get** **size**(): {number} - -###### Returns - -{number} +* `size` {number} ### Methods diff --git a/pages/v5.x/webpack/namespaces/util/namespaces/runtime.md b/pages/v5.x/webpack/namespaces/util/namespaces/runtime.md index 252eadd..5adf253 100644 --- a/pages/v5.x/webpack/namespaces/util/namespaces/runtime.md +++ b/pages/v5.x/webpack/namespaces/util/namespaces/runtime.md @@ -26,17 +26,9 @@ * `clone` {RuntimeSpecMap} * Returns: {RuntimeSpecMap} -### Accessors +### Properties -#### Accessor: `size` - -##### Get Signature - -> **get** **size**(): {number} - -###### Returns - -{number} +* `size` {number} ### Methods @@ -92,17 +84,9 @@ * `iterable` {Iterable} * Returns: {RuntimeSpecSet} -### Accessors - -#### Accessor: `size` - -##### Get Signature - -> **get** **size**(): {number} - -###### Returns +### Properties -{number} +* `size` {number} ### Methods diff --git a/pages/v5.x/webpack/namespaces/web.md b/pages/v5.x/webpack/namespaces/web.md index 3e5c7f2..810428b 100644 --- a/pages/v5.x/webpack/namespaces/web.md +++ b/pages/v5.x/webpack/namespaces/web.md @@ -20,6 +20,7 @@ * `buildMeta` {BuildMeta} * `chunk` {Chunk} * `chunkGraph` {ChunkGraph} +* `chunksIterable` {Iterable} * `codeGenerationDependencies` {Dependency[]} * `compilation` {Compilation} * `context` {string} @@ -27,202 +28,41 @@ * `dependencies` {Dependency[]} * `dependentHash` {boolean} * `depth` {number} +* `errors` {any} +* `exportsArgument` {string} * `factoryMeta` {FactoryMeta} * `fullHash` {boolean} +* `hasEqualsChunks` {any} +* `hash` {string} * `hot` {boolean} * `id` {string|number} * `index` {number} * `index2` {number} * `issuer` {Module} +* `isUsed` {any} * `layer` {string} +* `moduleArgument` {string} * `name` {string} * `needId` {boolean} +* `optimizationBailout` {string|object[]} +* `optional` {boolean} * `parent` {DependenciesBlock} * `presentationalDependencies` {Dependency[]} * `profile` {ModuleProfile} +* `renderedHash` {string} * `resolveOptions` {ResolveOptions} * `stage` {number} * `type` {string} * `used` {any} +* `usedExports` {boolean|SortableSet} * `useSimpleSourceMap` {boolean} * `useSourceMap` {boolean} +* `warnings` {any} * `STAGE_ATTACH` {number} Runtime modules which attach to handlers of other runtime modules * `STAGE_BASIC` {number} Runtime modules with simple dependencies on other runtime modules * `STAGE_NORMAL` {number} Runtime modules without any dependencies to other runtime modules * `STAGE_TRIGGER` {number} Runtime modules which trigger actions on bootstrap -### Accessors - -#### Accessor: `chunksIterable` - -##### Get Signature - -> **get** **chunksIterable**(): {Iterable} - -###### Returns - -{Iterable} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`chunksIterable`](../../globals.md#chunksiterable-3) - -#### Accessor: `errors` - -##### Get Signature - -> **get** **errors**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`errors`](../../globals.md#errors-4) - -#### Accessor: `exportsArgument` - -##### Get Signature - -> **get** **exportsArgument**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`exportsArgument`](../../globals.md#exportsargument-3) - -#### Accessor: `hasEqualsChunks` - -##### Get Signature - -> **get** **hasEqualsChunks**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`hasEqualsChunks`](../../globals.md#hasequalschunks-3) - -#### Accessor: `hash` - -##### Get Signature - -> **get** **hash**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`hash`](../../globals.md#hash-7) - -#### Accessor: `isUsed` - -##### Get Signature - -> **get** **isUsed**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`isUsed`](../../globals.md#isused-3) - -#### Accessor: `moduleArgument` - -##### Get Signature - -> **get** **moduleArgument**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`moduleArgument`](../../globals.md#moduleargument-3) - -#### Accessor: `optimizationBailout` - -##### Get Signature - -> **get** **optimizationBailout**(): {string|object[]} - -###### Deprecated - -###### Returns - -{string|object[]} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`optimizationBailout`](../../globals.md#optimizationbailout-3) - -#### Accessor: `optional` - -##### Get Signature - -> **get** **optional**(): {boolean} - -###### Returns - -{boolean} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`optional`](../../globals.md#optional-4) - -#### Accessor: `renderedHash` - -##### Get Signature - -> **get** **renderedHash**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`renderedHash`](../../globals.md#renderedhash-5) - -#### Accessor: `usedExports` - -##### Get Signature - -> **get** **usedExports**(): {boolean|SortableSet} - -###### Returns - -{boolean|SortableSet} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`usedExports`](../../globals.md#usedexports-3) - -#### Accessor: `warnings` - -##### Get Signature - -> **get** **warnings**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`warnings`](../../globals.md#warnings-4) - ### Methods #### `addBlock(block)` @@ -615,6 +455,7 @@ Apply the plugin * `buildMeta` {BuildMeta} * `chunk` {Chunk} * `chunkGraph` {ChunkGraph} +* `chunksIterable` {Iterable} * `codeGenerationDependencies` {Dependency[]} * `compilation` {Compilation} * `context` {string} @@ -622,202 +463,41 @@ Apply the plugin * `dependencies` {Dependency[]} * `dependentHash` {boolean} * `depth` {number} +* `errors` {any} +* `exportsArgument` {string} * `factoryMeta` {FactoryMeta} * `fullHash` {boolean} +* `hasEqualsChunks` {any} +* `hash` {string} * `hot` {boolean} * `id` {string|number} * `index` {number} * `index2` {number} * `issuer` {Module} +* `isUsed` {any} * `layer` {string} +* `moduleArgument` {string} * `name` {string} * `needId` {boolean} +* `optimizationBailout` {string|object[]} +* `optional` {boolean} * `parent` {DependenciesBlock} * `presentationalDependencies` {Dependency[]} * `profile` {ModuleProfile} +* `renderedHash` {string} * `resolveOptions` {ResolveOptions} * `stage` {number} * `type` {string} * `used` {any} +* `usedExports` {boolean|SortableSet} * `useSimpleSourceMap` {boolean} * `useSourceMap` {boolean} +* `warnings` {any} * `STAGE_ATTACH` {number} Runtime modules which attach to handlers of other runtime modules * `STAGE_BASIC` {number} Runtime modules with simple dependencies on other runtime modules * `STAGE_NORMAL` {number} Runtime modules without any dependencies to other runtime modules * `STAGE_TRIGGER` {number} Runtime modules which trigger actions on bootstrap -### Accessors - -#### Accessor: `chunksIterable` - -##### Get Signature - -> **get** **chunksIterable**(): {Iterable} - -###### Returns - -{Iterable} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`chunksIterable`](../../globals.md#chunksiterable-3) - -#### Accessor: `errors` - -##### Get Signature - -> **get** **errors**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`errors`](../../globals.md#errors-4) - -#### Accessor: `exportsArgument` - -##### Get Signature - -> **get** **exportsArgument**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`exportsArgument`](../../globals.md#exportsargument-3) - -#### Accessor: `hasEqualsChunks` - -##### Get Signature - -> **get** **hasEqualsChunks**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`hasEqualsChunks`](../../globals.md#hasequalschunks-3) - -#### Accessor: `hash` - -##### Get Signature - -> **get** **hash**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`hash`](../../globals.md#hash-7) - -#### Accessor: `isUsed` - -##### Get Signature - -> **get** **isUsed**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`isUsed`](../../globals.md#isused-3) - -#### Accessor: `moduleArgument` - -##### Get Signature - -> **get** **moduleArgument**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`moduleArgument`](../../globals.md#moduleargument-3) - -#### Accessor: `optimizationBailout` - -##### Get Signature - -> **get** **optimizationBailout**(): {string|object[]} - -###### Deprecated - -###### Returns - -{string|object[]} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`optimizationBailout`](../../globals.md#optimizationbailout-3) - -#### Accessor: `optional` - -##### Get Signature - -> **get** **optional**(): {boolean} - -###### Returns - -{boolean} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`optional`](../../globals.md#optional-4) - -#### Accessor: `renderedHash` - -##### Get Signature - -> **get** **renderedHash**(): {string} - -###### Returns - -{string} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`renderedHash`](../../globals.md#renderedhash-5) - -#### Accessor: `usedExports` - -##### Get Signature - -> **get** **usedExports**(): {boolean|SortableSet} - -###### Returns - -{boolean|SortableSet} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`usedExports`](../../globals.md#usedexports-3) - -#### Accessor: `warnings` - -##### Get Signature - -> **get** **warnings**(): {any} - -###### Returns - -{any} - -##### Inherited from - -[`RuntimeModule`](../../globals.md#runtimemodule).[`warnings`](../../globals.md#warnings-4) - ### Methods #### `addBlock(block)` diff --git a/plugins/processor.mjs b/plugins/processor.mjs index eac1b5e..4efbfdb 100644 --- a/plugins/processor.mjs +++ b/plugins/processor.mjs @@ -7,6 +7,19 @@ import { join } from "node:path"; export function load(app) { // Merge `export=` namespaces into their parent app.converter.on(Converter.EVENT_RESOLVE_BEGIN, (context) => { + context.project + .getReflectionsByKind(ReflectionKind.Accessor) + .forEach((accessor) => { + accessor.kind = ReflectionKind.Property; + if (accessor.getSignature) { + accessor.type = accessor.getSignature.type; + accessor.comment = accessor.getSignature.comment; + } else if (accessor.setSignature) { + accessor.type = accessor.setSignature.parameters?.[0]?.type; + accessor.comment = accessor.setSignature.comment; + } + }); + context.project .getReflectionsByKind(ReflectionKind.Namespace) .filter((ref) => ref.name === "export=") From c01a33d5aaf3381dd363cace756f6a5a1f99a158 Mon Sep 17 00:00:00 2001 From: Katari Date: Fri, 13 Mar 2026 18:05:07 +0530 Subject: [PATCH 2/2] adding comment --- plugins/processor.mjs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/plugins/processor.mjs b/plugins/processor.mjs index 4efbfdb..8426aa5 100644 --- a/plugins/processor.mjs +++ b/plugins/processor.mjs @@ -5,8 +5,8 @@ import { join } from "node:path"; * @param {import('typedoc-plugin-markdown').MarkdownApplication} app */ export function load(app) { - // Merge `export=` namespaces into their parent app.converter.on(Converter.EVENT_RESOLVE_BEGIN, (context) => { + // Convert accessors to properties to simplify documentation context.project .getReflectionsByKind(ReflectionKind.Accessor) .forEach((accessor) => { @@ -20,6 +20,7 @@ export function load(app) { } }); + // Merge `export=` namespaces into their parent context.project .getReflectionsByKind(ReflectionKind.Namespace) .filter((ref) => ref.name === "export=")