# @types/dotenv-webpack

> TypeScript definitions for dotenv-webpack

Latest version **7.0.8** (published 2024-10-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/dotenv-webpack
pnpm add @types/dotenv-webpack
yarn add @types/dotenv-webpack
bun add @types/dotenv-webpack
```

## 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 | 7.0.8 |
| Published | 2024-10-29 |
| First published | 2018-04-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 7.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51462 |
| Maintainers | types |

## Links

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

## Dependencies (3)

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

## Recent versions

- 7.0.8 (latest) — 2024-10-29
- 7.0.7 (ts4.5) — 2023-11-07
- 7.0.4 (ts4.3) — 2023-05-25
- 7.0.3 (ts3.7) — 2021-07-06
- 7.0.0 (ts3.5) — 2021-03-05
- 5.0.0 (ts3.2) — 2020-10-30
- 1.8.0 (ts3.0) — 2020-06-07
- 1.7.0 (ts2.7) — 2019-01-19
- 7.0.6 — 2023-10-18
- 7.0.5 — 2023-09-22
- 7.0.2 — 2021-05-07
- 7.0.1 — 2021-03-25
- 6.0.0 — 2021-03-05
- 3.0.0 — 2020-09-19
- 1.5.0 — 2018-04-09

## README

# Installation
> `npm install --save @types/dotenv-webpack`

# Summary
This package contains type definitions for dotenv-webpack (https://github.com/mrsteele/dotenv-webpack).

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

/**
 * A secure webpack plugin that supports dotenv and other environment variables
 * and only exposes what you choose and use.
 */
declare class DotenvWebpackPlugin {
    constructor(options?: DotenvWebpackPlugin.Options);
    apply(compiler: Compiler): void;
}

declare namespace DotenvWebpackPlugin {
    interface Options {
        /**
         * The path to your environment variables.
         * @default './.env'.
         */
        path?: string | undefined;

        /**
         * If `false` ignore safe-mode, if `true` load `'./.env.example'`, if a `string` load that file as the sample.
         * @default false
         */
        safe?: boolean | string | undefined;

        /**
         * Whether to allow empty strings in safe mode.
         * If false, will throw an error if any env variables are empty (but only if safe mode is enabled).
         * @default false
         */
        allowEmptyValues?: boolean | undefined;

        /**
         * Set to `true` if you would rather load all system variables as well (useful for CI purposes).
         * @default false
         */
        systemvars?: boolean | undefined;

        /**
         * If `true`, all warnings will be surpressed.
         * @default false
         */
        silent?: boolean | undefined;

        /**
         * Allows your variables to be "expanded" for reusability within your .env file.
         * @default false
         */
        expand?: boolean | undefined;

        /**
         * Adds support for dotenv-defaults. If set to `true`, uses `./.env.defaults`. If a `string`, uses that location for a defaults file.
         * Read more at {@link https://www.npmjs.com/package/dotenv-defaults}.
         * @default false
         */
        defaults?: boolean | string | undefined;

        /**
         * Override the automatic check whether to stub `process.env`.
         * @default false
         */
        ignoreStub?: boolean | undefined;

        /**
         * The prefix to use before the name of your env variables.
         * @default 'process.env.'
         */
        prefix?: string | undefined;
    }
}

export = DotenvWebpackPlugin;

````

### Additional Details
 * Last updated: Tue, 29 Oct 2024 10:02:30 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node), [tapable](https://npmjs.com/package/tapable), [webpack](https://npmjs.com/package/webpack)

# Credits
These definitions were written by [Karol Majewski](https://github.com/karol-majewski), [Dave Cardwell](https://github.com/davecardwell), and [Piotr Błażejewicz](https://github.com/peterblazejewicz).

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