@types/webpack-hot-middleware

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

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;
    }

    type Logger = (message?: any, ...optionalParams: any[]) => void;

    interface EventStream {
        publish(payload: any): void;
        close(): void;
    }
}

Additional Details

• Last updated: Tue, 07 Nov 2023 15:11:36 GMT
• Dependencies: @types/connect, tapable, webpack

Credits

These definitions were written by Benjamin Lim, Ron Martinez, Chris Abrams, Ilya Zelenko, and Rodrigo Saboya.