.openInEditor throws

sindresorhus · Mar 5, 2024 · 9610075 · 9610075
1 parent 063b68f
commit 9610075
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/index.js b/index.js
@@ -73,8 +73,12 @@ class ElectronStore extends Conf {
 		initDataListener();
 	}
 
-	openInEditor() {
-		return shell.openPath(this.path);
+	async openInEditor() {
+		const error = await shell.openPath(this.path);
+
+		if (error) {
+			throw new Error(error);
+		}
 	}
 }
 

diff --git a/index.test-d.ts b/index.test-d.ts
@@ -18,7 +18,7 @@ store.reset('foo');
 store.has('foo');
 store.clear();
 
-store.openInEditor();
+await store.openInEditor();
 
 store.size; // eslint-disable-line @typescript-eslint/no-unused-expressions
 store.store; // eslint-disable-line @typescript-eslint/no-unused-expressions

diff --git a/readme.md b/readme.md
@@ -379,7 +379,7 @@ Get the path to the storage file.
 
 Open the storage file in the user's editor.
 
-See [`electron.shell.openPath(path)`](https://www.electronjs.org/docs/latest/api/shell#shellopenpathpath) for handling return value.
+Will throw if the file failed to open.
 
 ### initRenderer()