@types/webpack-hot-middleware
Version:
TypeScript definitions for webpack-hot-middleware
63 lines (52 loc) • 2.33 kB
Markdown
# Installation
> `npm install --save @types/webpack-hot-middleware`
# Summary
This package contains type definitions for webpack-hot-middleware (https://github.com/webpack-contrib/webpack-hot-middleware).
# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/webpack-hot-middleware.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/webpack-hot-middleware/index.d.ts)
````ts
import { NextHandleFunction } from "connect";
import * as webpack from "webpack";
export = WebpackHotMiddleware;
declare function WebpackHotMiddleware(
compiler: webpack.Compiler | webpack.MultiCompiler,
options?: WebpackHotMiddleware.MiddlewareOptions,
): NextHandleFunction & WebpackHotMiddleware.EventStream;
declare namespace WebpackHotMiddleware {
interface ClientOptions {
path?: string | undefined;
reload?: boolean | undefined;
name?: string | undefined;
timeout?: number | undefined;
overlay?: boolean | undefined;
noInfo?: boolean | undefined;
quiet?: boolean | undefined;
dynamicPublicPath?: boolean | undefined;
autoConnect?: boolean | undefined;
ansiColors?: {
[key: string]: any;
} | undefined;
overlayStyles?: {
[key: string]: any;
} | undefined;
overlayWarnings?: boolean | undefined;
}
interface MiddlewareOptions {
log?: false | Logger | undefined;
path?: string | undefined;
heartbeat?: number | undefined;
statsOptions?: webpack.StatsOptions;
}
type Logger = (message?: any, ...optionalParams: any[]) => void;
interface EventStream {
publish(payload: any): void;
close(): void;
}
}
````
### Additional Details
* Last updated: Sun, 10 Aug 2025 17:35:27 GMT
* Dependencies: [@types/connect](https://npmjs.com/package/@types/connect), [tapable](https://npmjs.com/package/tapable), [webpack](https://npmjs.com/package/webpack)
# Credits
These definitions were written by [Benjamin Lim](https://github.com/bumbleblym), [Ron Martinez](https://github.com/icylace), [Chris Abrams](https://github.com/chrisabrams), [Ilya Zelenko](https://github.com/iliyaZelenko), and [Rodrigo Saboya](https://github.com/saboya).