Add title option to unhandled.logError()

sindresorhus · Nov 11, 2018 · 9a7ccfe · 9a7ccfe
1 parent 76e4d12
commit 9a7ccfe
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 4 deletions.
diff --git a/example.js b/example.js
@@ -22,5 +22,5 @@ let mainWindow;
 	mainWindow = new electron.BrowserWindow();
 	mainWindow.loadURL('https://google.com');
 
-	unhandled.logError(new Error('Test'));
+	unhandled.logError(new Error('Test'), {title: 'Custom Title'});
 })();
diff --git a/index.js b/index.js
@@ -102,6 +102,11 @@ module.exports = inputOptions => {
 	}
 };
 
-module.exports.logError = error => {
-	handleError(`${appName} encountered an error.`, error);
+module.exports.logError = (error, options) => {
+	options = {
+		title: `${appName} encountered an error`,
+		...options
+	};
+
+	handleError(options.title, error);
 };
diff --git a/readme.md b/readme.md
@@ -75,12 +75,29 @@ unhandled({
 
 [Example of how the GitHub issue will look like.](https://github.com/sindresorhus/electron-unhandled/issues/new?body=%60%60%60%0AError%3A+Test%0A++++at+%2FUsers%2Fsindresorhus%2Fdev%2Foss%2Felectron-unhandled%2Fexample.js%3A27%3A21%0A%60%60%60%0A%0A---%0A%0AExample+1.1.0%0AElectron+3.0.8%0Adarwin+18.2.0%0ALocale%3A+en-US)
 
-### unhandled.logError(error)
+### unhandled.logError(error, [options])
 
 Log an error. This does the same as with caught unhandled errors.
 
 It will use the same options specified in the `unhandled()` call or the defaults.
 
+#### error
+
+Type: `Error`
+
+Error to log.
+
+#### options
+
+Type: `Object`
+
+##### title
+
+Type: `string`<br>
+Default: `${appName} encountered an error`
+
+Title of the error dialog.
+
 
 ## Related