Installation
npm install --save @types/webpack-livereload-plugin
Summary
This package contains type definitions for webpack-livereload-plugin (https://github.com/statianzo/webpack-livereload-plugin#readme).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/webpack-livereload-plugin.
index.d.ts
import { ServerOptions } from "https";
import { Plugin, Stats } from "webpack";
import webpack = require("webpack");
declare class LiveReloadPlugin extends Plugin {
readonly isRunning: boolean;
constructor(options?: LiveReloadPlugin.Options);
apply(compiler: webpack.Compiler): void;
start(watching: any, cb: () => void): void;
done(stats: Stats): void;
failed(): void;
autoloadJs(): string;
scriptTag(source: string): string;
applyCompilation(compilation: webpack.compilation.Compilation): void;
}
declare namespace LiveReloadPlugin {
interface Options extends Pick<ServerOptions, "cert" | "key" | "pfx"> {
/**
* protocol for livereload `<script>` src attribute value
* @default protocol of the page, either `http` or `https`
*/
protocol?: string | undefined;
/**
* The desired port for the livereload server.
* If you define port 0, an available port will be searched for, starting from 35729.
* @default 35729
*/
port?: number | undefined;
/**
* he desired hostname for the appended `<script>` (if present) to point to
* @default hostname of the page, like `localhost` or 10.0.2.2
*/
hostname?: string | undefined;
/**
* livereload `<script>` automatically to `<head>`.
* @default false
*/
appendScriptTag?: boolean | undefined;
/**
* RegExp of files to ignore. Null value means ignore nothing.
* It is also possible to define an array and use multiple anymatch patterns
*/
ignore?: RegExp | RegExp[] | null | undefined;
/**
* amount of milliseconds by which to delay the live reload (in case build takes longer)
* @default 0
*/
delay?: number | undefined;
/**
* create hash for each file source and only notify livereload if hash has changed
* @default false
*/
useSourceHash?: boolean | undefined;
}
}
export = LiveReloadPlugin;Additional Details
- Last updated: Tue, 07 Nov 2023 15:11:36 GMT
- Dependencies: @types/webpack
Credits
These definitions were written by Piotr Błażejewicz.