Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslnode 18–226 runs
build_error
glibcnode 18–226 runs
build_error
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
TypedocWebpackPlugin
✓ const TypedocWebpackPlugin = require('typedoc-webpack-plugin');
✗ import TypedocWebpackPlugin from 'typedoc-webpack-plugin';
CommonJS only; no ES module or TypeScript type definitions.
TypedocWebpackPlugin
✓ const TypedocWebpackPlugin = require('typedoc-webpack-plugin');
✗ const { TypedocWebpackPlugin } = require('typedoc-webpack-plugin');
Default export, not named export.
Constructor usage
✓ plugins: [new TypedocWebpackPlugin(options, input)]
✗ new TypedocWebpackPlugin({...}, options)
First argument is options object, second is optional input string/array.
Webpack 4 configuration using typedoc-webpack-plugin to generate docs from src/ into ./docs.
const TypedocWebpackPlugin = require('typedoc-webpack-plugin');
module.exports = {
entry: './src/index.ts',
output: { path: './dist' },
resolve: { extensions: ['.ts', '.js'] },
module: { rules: [{ test: /\.ts$/, loader: 'ts-loader' }] },
plugins: [
new TypedocWebpackPlugin({
out: './docs',
module: 'commonjs',
target: 'es5',
exclude: '**/node_modules/**/*.*',
experimentalDecorators: true,
excludeExternals: true
}, './src')
]
};
Errors
Common errors & fixes
TypeError: TypedocWebpackPlugin is not a constructor
ESM import used or wrong export access.
fixUse const TypedocWebpackPlugin = require('typedoc-webpack-plugin'); Error: Cannot find module 'typedoc'
Missing peer dependency typedoc.
fixRun: npm install typedoc@0.5 --save-dev
Audit
Dependencies
typedocrequiredpeer dependency required