UNPKG

1.86 kBJavaScriptView Raw
1/**
2 * @typedef {Object} ErrorOverlayOptions
3 * @property {string} [entry] Path to a JS file that sets up the error overlay integration.
4 * @property {string} [module] The error overlay module to use.
5 * @property {string} [sockHost] The socket host to use (WDS only).
6 * @property {import('type-fest').LiteralUnion<'wds' | 'whm' | 'wps', string>} [sockIntegration] Path to a JS file that sets up the Webpack socket integration.
7 * @property {string} [sockPath] The socket path to use (WDS only).
8 * @property {number} [sockPort] The socket port to use (WDS only).
9 */
10
11/**
12 * @typedef {import('type-fest').SetRequired<ErrorOverlayOptions, 'entry' | 'module' | 'sockIntegration'>} NormalizedErrorOverlayOptions
13 */
14
15/**
16 * @typedef {Object} ReactRefreshPluginOptions
17 * @property {boolean} [disableRefreshCheck] Disables detection of react-refresh's Babel plugin (Deprecated since v0.3.0).
18 * @property {string | RegExp | Array<string | RegExp>} [exclude] Files to explicitly exclude from processing.
19 * @property {boolean} [forceEnable] Enables the plugin forcefully.
20 * @property {string | RegExp | Array<string | RegExp>} [include] Files to explicitly include for processing.
21 * @property {boolean | ErrorOverlayOptions} [overlay] Modifies how the error overlay integration works in the plugin.
22 * @property {boolean} [useLegacyWDSSockets] Uses a custom SocketJS implementation for older versions of webpack-dev-server.
23 */
24
25/**
26 * @typedef {Object} OverlayOverrides
27 * @property {false | NormalizedErrorOverlayOptions} overlay Modifies how the error overlay integration works in the plugin.
28 */
29
30/**
31 * @typedef {import('type-fest').Merge<import('type-fest').SetRequired<import('type-fest').Except<ReactRefreshPluginOptions, 'disableRefreshCheck' | 'overlay'>, 'exclude' | 'include'>, OverlayOverrides>} NormalizedPluginOptions
32 */
33
34module.exports = {};