@types/dotenv-webpack/README.md

TypeScript definitions for dotenv-webpack

# 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).