Meta tweaks

.gitattributes

@@ -1,2 +1 @@
-* text=auto
-*.js text eol=lf
+* text=auto eol=lf

.travis.yml

@@ -1,3 +1,3 @@
 language: node_js
 node_js:
-  - 'node'
+  - '10'

index.d.ts

@@ -41,15 +41,21 @@ export default function electronDebug(options?: Options): void;
 
 /**
  * Reload the specified `BrowserWindow` instance or the focused one.
+ *
+ * @param window - Default: `BrowserWindow.getFocusedWindow()`
  */
-export function refresh(window?: BrowserWindow = BrowserWindow.getFocusedWindow()): void;
+export function refresh(window?: BrowserWindow): void;
 
 /**
  * Toggle DevTools for the specified `BrowserWindow` instance or the focused one.
+ *
+ * @param window - Default: `BrowserWindow.getFocusedWindow()`
  */
-export function devTools(window?: BrowserWindow = BrowserWindow.getFocusedWindow()): void;
+export function devTools(window?: BrowserWindow): void;
 
 /**
  * Open DevTools for the specified `BrowserWindow` instance or the focused one.
+ *
+ * @param window - Default: `BrowserWindow.getFocusedWindow()`
  */
-export function openDevTools(window?: BrowserWindow = BrowserWindow.getFocusedWindow()): void;
+export function openDevTools(window?: BrowserWindow): void;

index.js

@@ -66,23 +66,23 @@ const addExtensionIfInstalled = (name, getPath) => {
 	} catch (_) {}
 };
 
-module.exports = opts => {
-	opts = Object.assign({
+module.exports = options => {
+	options = Object.assign({
 		enabled: null,
 		showDevTools: true,
 		devToolsMode: 'undocked'
-	}, opts);
+	}, options);
 
-	if (opts.enabled === false || (opts.enabled === null && !isDev)) {
+	if (options.enabled === false || (options.enabled === null && !isDev)) {
 		return;
 	}
 
-	if (opts.devToolsMode !== 'previous') {
-		devToolsOptions.mode = opts.devToolsMode;
+	if (options.devToolsMode !== 'previous') {
+		devToolsOptions.mode = options.devToolsMode;
 	}
 
 	app.on('browser-window-created', (event, win) => {
-		if (opts.showDevTools) {
+		if (options.showDevTools) {
 			win.webContents.once('devtools-opened', () => {
 				// Workaround for https://github.com/electron/electron/issues/13095
 				setImmediate(() => {
@@ -92,7 +92,7 @@ module.exports = opts => {
 
 			/// Workaround for https://github.com/electron/electron/issues/12438
 			win.webContents.once('dom-ready', () => {
-				openDevTools(win, opts.showDevTools);
+				openDevTools(win, options.showDevTools);
 			});
 		}
 	});

index.test-d.ts

@@ -3,8 +3,8 @@ import {BrowserWindow} from 'electron';
 import electronDebug, {refresh, devTools, openDevTools} from '.';
 
 expectType<void>(electronDebug({
-  enabled: true,
-  showDevTools: true
+	enabled: true,
+	showDevTools: true
 }));
 
 expectType<void>(refresh(new BrowserWindow()));

readme.md

@@ -54,14 +54,15 @@ $ npm install electron-debug
 
 ```js
 const {app, BrowserWindow} = require('electron');
+const debug = require('electron-debug');
 
-require('electron-debug')();
+debug();
 
 let win;
-
-app.on('ready', () => {
+(async () => {
+	await app.whenReady();
 	win = new BrowserWindow();
-});
+})();
 ```
 
 
@@ -75,6 +76,8 @@ Install keyboard shortcuts and optionally activate DevTools on each created `Bro
 
 #### options
 
+Type: `Object`
+
 ##### enabled
 
 Type: `boolean`

test.js

@@ -1,7 +1,8 @@
 'use strict';
 const electron = require('electron');
+const debug = require('.');
 
-require('.')();
+debug();
 
 function load(url) {
 	const win = new electron.BrowserWindow({show: true});