{"id":20633,"library":"typedoc-webpack-plugin","title":"typedoc-webpack-plugin","description":"Runs TypeDoc documentation generation as a Webpack plugin. Latest version 1.1.4 (last released 2017) requires typedoc ^0.5.0 as peer dependency. It is an older, unmaintained plugin; consider using typedoc-plugin-webpack instead. It supports file/directory input, JSON output, and mirrors TypeDoc options.","status":"abandoned","version":"1.1.4","language":"javascript","source_language":"en","source_url":"https://github.com/Microsoft/Typedoc-Webpack-Plugin","tags":["javascript","Typedoc","Webpack","Documentation","Typescript","Microsoft"],"install":[{"cmd":"npm install typedoc-webpack-plugin","lang":"bash","label":"npm"},{"cmd":"yarn add typedoc-webpack-plugin","lang":"bash","label":"yarn"},{"cmd":"pnpm add typedoc-webpack-plugin","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"peer dependency required","package":"typedoc","optional":false}],"imports":[{"note":"CommonJS only; no ES module or TypeScript type definitions.","wrong":"import TypedocWebpackPlugin from 'typedoc-webpack-plugin';","symbol":"TypedocWebpackPlugin","correct":"const TypedocWebpackPlugin = require('typedoc-webpack-plugin');"},{"note":"Default export, not named export.","wrong":"const { TypedocWebpackPlugin } = require('typedoc-webpack-plugin');","symbol":"TypedocWebpackPlugin","correct":"const TypedocWebpackPlugin = require('typedoc-webpack-plugin');"},{"note":"First argument is options object, second is optional input string/array.","wrong":"new TypedocWebpackPlugin({...}, options)","symbol":"Constructor usage","correct":"plugins: [new TypedocWebpackPlugin(options, input)]"}],"quickstart":{"code":"const TypedocWebpackPlugin = require('typedoc-webpack-plugin');\nmodule.exports = {\n  entry: './src/index.ts',\n  output: { path: './dist' },\n  resolve: { extensions: ['.ts', '.js'] },\n  module: { rules: [{ test: /\\.ts$/, loader: 'ts-loader' }] },\n  plugins: [\n    new TypedocWebpackPlugin({\n      out: './docs',\n      module: 'commonjs',\n      target: 'es5',\n      exclude: '**/node_modules/**/*.*',\n      experimentalDecorators: true,\n      excludeExternals: true\n    }, './src')\n  ]\n};","lang":"javascript","description":"Webpack 4 configuration using typedoc-webpack-plugin to generate docs from src/ into ./docs."},"warnings":[{"fix":"Use typedoc-plugin-webpack instead.","message":"Plugin is unmaintained; no updates since 2017. May not work with Webpack 5 or newer TypeDoc versions.","severity":"breaking","affected_versions":">=1.0.0"},{"fix":"Pin TypeDoc to 0.5.x or migrate to alternative.","message":"TypeDoc peer dependency is ^0.5.0; later TypeDoc versions have breaking API changes.","severity":"deprecated","affected_versions":">=0.6.0"},{"fix":"Refer to TypeDoc 0.5 documentation.","message":"Options are passed directly to TypeDoc; not all TypeDoc options may be supported.","severity":"gotcha","affected_versions":">=0.0.0"}],"env_vars":null,"last_verified":"2026-04-25T00:00:00.000Z","next_check":"2026-07-24T00:00:00.000Z","problems":[{"fix":"Use const TypedocWebpackPlugin = require('typedoc-webpack-plugin');","cause":"ESM import used or wrong export access.","error":"TypeError: TypedocWebpackPlugin is not a constructor"},{"fix":"Run: npm install typedoc@0.5 --save-dev","cause":"Missing peer dependency typedoc.","error":"Error: Cannot find module 'typedoc'"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}