Interface Options

Hierarchy

  • Options

Indexable

[option: string]: any

Properties

cache? chunks? chunksSortMode? excludeChunks? favicon? filename? hash? inject? meta? minify? publicPath? scriptLoading? showErrors? template? templateContent? templateParameters? title? xhtml?

Properties

Optional cache

cache?: boolean

Emit the file only if it was changed.

Default

true

Optional chunks

chunks?: string[] | "all"

List all entries which should be injected

Optional chunksSortMode

chunksSortMode?: "auto" | "manual" | ((entryNameA, entryNameB) => number)

Allows to control how chunks should be sorted before they are included to the html.

Type declaration

    • (entryNameA, entryNameB): number

    • Parameters

      • entryNameA: string
      • entryNameB: string

      Returns number

Default

'auto'

Optional excludeChunks

excludeChunks?: string[]

List all entries which should not be injected

Optional favicon

favicon?: string | false

Path to the favicon icon

Optional filename

filename?: string | ((entryName) => string)

The file to write the HTML to. Supports subdirectories eg: assets/admin.html [name] will be replaced by the entry name Supports a function to generate the name

Type declaration

    • (entryName): string

    • Parameters

      • entryName: string

      Returns string

Default

'index.html'

Optional hash

hash?: boolean

If true then append a unique webpack compilation hash to all included scripts and CSS files. This is useful for cache busting

Optional inject

inject?: boolean | "head" | "body"

Inject all assets into the given template or templateContent.

Optional meta

meta?: false | {
    [name: string]: string | false | {
        [attributeName: string]: string | boolean;
    };
}

Inject meta tags

Type declaration

  • [name: string]: string | false | {
        [attributeName: string]: string | boolean;
    }

Optional minify

minify?: boolean | Options | "auto"

HTML Minification options accepts the following values:

Optional publicPath

publicPath?: string

By default the public path is set to auto - that way the html-webpack-plugin will try to set the publicPath according to the current filename and the webpack publicPath setting

Optional scriptLoading

scriptLoading?: "module" | "blocking" | "defer"

Set up script loading blocking will result in defer will result in

Default

'defer'

Optional showErrors

showErrors?: boolean

Render errors into the HTML page

Optional template

template?: string

The webpack require path to the template.

See

https://github.com/jantimon/html-webpack-plugin/blob/master/docs/template-option.md

Optional templateContent

templateContent?: string | false | ((templateParameters) => string | Promise<string>) | Promise<string>

Allow to use a html string instead of reading from a file

Type declaration

    • (templateParameters): string | Promise<string>

    • Parameters

      • templateParameters: {
            [option: string]: any;
        }
        • [option: string]: any

      Returns string | Promise<string>

Optional templateParameters

templateParameters?: false | ((compilation, assets, assetTags, options) => {
    [option: string]: any;
} | Promise<{
    [option: string]: any;
}>) | {
    [option: string]: any;
}

Allows to overwrite the parameters used in the template

Type declaration

    • (compilation, assets, assetTags, options): {
          [option: string]: any;
      } | Promise<{
          [option: string]: any;
      }>

    • Parameters

      • compilation: any
      • assets: {
            css: string[];
            favicon?: string;
            js: string[];
            manifest?: string;
            publicPath: string;
        }
        • css: string[]
        • Optional favicon?: string
        • js: string[]
        • Optional manifest?: string
        • publicPath: string
      • assetTags: {
            bodyTags: HtmlTagObject[];
            headTags: HtmlTagObject[];
        }
      • options: ProcessedOptions

      Returns {
          [option: string]: any;
      } | Promise<{
          [option: string]: any;
      }>

Type declaration

  • [option: string]: any

Optional title

title?: string

The title to use for the generated HTML document

Optional xhtml

xhtml?: boolean

Enforce self closing tags e.g.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc