# dts-generator-webpack-plugin

> A webpack plugin for running dts-generator

Latest version **1.0.0** (published 2017-10-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install dts-generator-webpack-plugin
pnpm add dts-generator-webpack-plugin
yarn add dts-generator-webpack-plugin
bun add dts-generator-webpack-plugin
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-10-08 |
| First published | 2017-10-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Matt Traynham |
| Maintainers | mtraynham |
| Keywords | webpack, plugin, dts, dts-generator, typescript |

## Links

- npm: https://www.npmjs.com/package/dts-generator-webpack-plugin
- Repository: https://github.com/mtraynham/dts-generator-webpack-plugin
- Homepage: https://github.com/mtraynham/dts-generator-webpack-plugin#README.MD
- Issues: https://github.com/mtraynham/dts-generator-webpack-plugin/issues
- npm.io page: https://npm.io/package/dts-generator-webpack-plugin

## Dependencies (3)

- [tmp](https://npm.io/package/tmp.md) ^0
- [bluebird](https://npm.io/package/bluebird.md) ^3
- [dts-generator](https://npm.io/package/dts-generator.md) ^2

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2017-10-08

## README

# dts-generator-webpack-plugin
A plugin that executes [dts-generator](https://github.com/SitePen/dts-generator) and appends the results to 
the webpack compilation as an additional asset.

## Usage
```typescript
import DtsGeneratorPlugin, {IDtsGeneratorPluginOptions} from 'dts-generator-webpack-plugin';
import resolve from 'path';
import {Configuration} from 'webpack';

const dtsGeneratorPluginOptions: IDtsGeneratorPluginOptions = {
    name: 'myPackage'
};
const webpackConfig: Configuration = {
    entry: 'index.ts',
    output: {
        path: resolve(__dirname, 'dist'),
    },
    plugins: [
        new DtsGeneratorPlugin(dtsGeneratorPluginOptions)
    ]
};
export default webpackConfig;
```

## Options
All [options provided by dts-generator](https://github.com/SitePen/dts-generator#options) are supported.  The
option `out` is no longer required and will be ignored if set as this plugin instead appends it as an
additional asset to the webpack build.  The Webpack configuration's `output` will instead decide
where the generated d.ts file is placed.

---
_Source: https://npm.io/package/dts-generator-webpack-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
