electron-reloader/index.d.ts

Simple auto-reloading for Electron apps during development

declare namespace electronReloader {
	interface Options {
		/**
		Ignore patterns passed to [`chokidar`](https://github.com/paulmillr/chokidar#path-filtering).

		By default, files/directories starting with a `.`, `.map` files, and `node_modules` directories are ignored. This option is additive to those.
		*/
		readonly ignore?: ReadonlyArray<string | RegExp>;

		/**
		Watch files used in the renderer process and reload the window when they change.

		@default true
		*/
		readonly watchRenderer?: boolean;

		/**
		Prints watched paths and when files change. Can be useful to make sure you set it up correctly.

		@default false
		*/
		readonly debug?: boolean;
	}
}

/**
@param moduleObject - Global `module` object.

@example
```
try {
	require('electron-reloader')(module);
} catch {}
```
*/
declare function electronReloader(
	moduleObject: NodeModule,
	options?: electronReloader.Options
): void;

export = electronReloader;