mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
90 lines
2.8 KiB
TypeScript
90 lines
2.8 KiB
TypeScript
// Type definitions for html-webpack-plugin v2.22.2
|
|
// Project: https://github.com/ampedandwired/html-webpack-plugin
|
|
// Definitions by: Simon Hartcher <http://github.com/deevus>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
///<reference types="webpack" />
|
|
|
|
declare module "html-webpack-plugin" {
|
|
import {Plugin} from "webpack";
|
|
|
|
interface HtmlWebpackPluginConfiguration {
|
|
/**
|
|
* The title to use for the generated HTML document.
|
|
*/
|
|
title?: string;
|
|
|
|
/**
|
|
* The file to write the HTML to. Defaults to index.html. You can specify a subdirectory here too (eg: `assets/admin.html`).
|
|
*/
|
|
filename?: string;
|
|
|
|
/**
|
|
* Webpack require path to the template. Please see the docs for details.
|
|
*/
|
|
template?: string;
|
|
|
|
/**
|
|
* `true | 'head' | 'body' | false`
|
|
*
|
|
* Inject all assets into the given template or templateContent - When passing true or 'body' all javascript resources will be placed at the bottom of the body element. 'head' will place the scripts in the head element.
|
|
*/
|
|
inject?: boolean | "head" | "body";
|
|
|
|
/**
|
|
* Adds the given favicon path to the output html.
|
|
*/
|
|
favicon?: string;
|
|
|
|
/**
|
|
* Pass a html-minifier options object to minify the output.
|
|
*
|
|
* https://github.com/kangax/html-minifier#options-quick-reference
|
|
*/
|
|
minify?: any;
|
|
|
|
/**
|
|
* `true | false` if `true` then append a unique webpack compilation hash to all included scripts and css files. This is useful for cache busting.
|
|
*/
|
|
hash?: boolean;
|
|
|
|
/**
|
|
* `true | false` if `true` (default) try to emit the file only if it was changed.
|
|
*/
|
|
cache?: boolean;
|
|
|
|
/**
|
|
* `true | false` if `true` (default) errors details will be written into the html page.
|
|
*/
|
|
showErrors?: boolean;
|
|
|
|
/**
|
|
* Allows you to add only some chunks (e.g. only the unit-test chunk)
|
|
*/
|
|
chunks?: string[];
|
|
|
|
/**
|
|
* Allows to control how chunks should be sorted before they are included to the html. Allowed values: `'none' | 'auto' | 'dependency' | {function}` - default: `'auto'`
|
|
*/
|
|
chunksSortMode?: "none" | "auto" | "dependency" | Function;
|
|
|
|
/**
|
|
* Allows you to skip some chunks (e.g. don't add the unit-test chunk)
|
|
*/
|
|
excludeChunks?: string[];
|
|
|
|
/**
|
|
* `true | false` If `true` render the link tags as self-closing, XHTML compliant. Default is `false`
|
|
*/
|
|
xhtml?: boolean;
|
|
}
|
|
|
|
interface HtmlWebpackPlugin {
|
|
new (): Plugin;
|
|
new (options: HtmlWebpackPluginConfiguration): Plugin;
|
|
}
|
|
|
|
const htmlWebpackPlugin: HtmlWebpackPlugin;
|
|
export = htmlWebpackPlugin;
|
|
}
|