# @types/circular-dependency-plugin

> TypeScript definitions for circular-dependency-plugin

Latest version **5.0.8** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/circular-dependency-plugin
pnpm add @types/circular-dependency-plugin
yarn add @types/circular-dependency-plugin
bun add @types/circular-dependency-plugin
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 5.0.8 |
| Published | 2023-11-07 |
| First published | 2019-03-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 5.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51436 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/circular-dependency-plugin
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/circular-dependency-plugin
- npm.io page: https://npm.io/package/@types/circular-dependency-plugin

## Dependencies (2)

- [webpack](https://npm.io/package/webpack.md) ^5.1.0
- [@types/node](https://npm.io/package/@types/node.md) *

## Recent versions

- 5.0.8 (latest) — 2023-11-07
- 5.0.6 (ts4.3) — 2023-09-04
- 5.0.5 (ts3.7) — 2021-11-01
- 5.0.1 (ts3.0) — 2020-05-27
- 5.0.0 (ts2.3) — 2019-03-18
- 5.0.7 — 2023-10-17
- 5.0.4 — 2021-09-29
- 5.0.3 — 2021-07-06
- 5.0.2 — 2021-03-25

## README

# Installation
> `npm install --save @types/circular-dependency-plugin`

# Summary
This package contains type definitions for circular-dependency-plugin (https://github.com/aackerman/circular-dependency-plugin).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/circular-dependency-plugin.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/circular-dependency-plugin/index.d.ts)
````ts
/// <reference types="node" />
import { Compilation, Compiler, Module, WebpackPluginInstance } from "webpack";

export = CircularDependencyPlugin;

/**
 * Detect modules with circular dependencies when bundling with webpack.
 */
declare class CircularDependencyPlugin implements WebpackPluginInstance {
    constructor(options?: CircularDependencyPlugin.Options);

    apply(compiler: Compiler): void;
    // Not exposing `isCyclic` because it isn't meant to be public, I believe
}

declare namespace CircularDependencyPlugin {
    interface Options {
        /**
         * @default false
         */
        allowAsyncCycles?: boolean | undefined;
        /**
         * @default process.cwd()
         */
        cwd?: string | undefined;
        /**
         * @default /$^/
         */
        exclude?: RegExp | undefined;
        /**
         * @default /.*\/
         */
        include?: RegExp | undefined;
        /**
         * @default false
         */
        failOnError?: boolean | undefined;
        /**
         * @default false
         */
        onDetected?:
            | false
            | ((x: {
                module: Module;
                paths: string[];
                compilation: Compilation;
            }) => void)
            | undefined;
        onEnd?: ((x: { compilation: Compilation }) => void) | undefined;
        onStart?: ((x: { compilation: Compilation }) => void) | undefined;
    }
}

````

### Additional Details
 * Last updated: Mon, 06 Nov 2023 22:41:05 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node), [webpack](https://npmjs.com/package/webpack)

# Credits
These definitions were written by [Olegs Jeremejevs](https://github.com/jeremejevs).

---
_Source: https://npm.io/package/@types/circular-dependency-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._