Allow awaiting .openInEditor() (#272)

Co-authored-by: Sindre Sorhus <[email protected]>

index.d.ts

@@ -59,8 +59,10 @@ declare class ElectronStore<T extends Record<string, any> = Record<string, unkno
 
  /**
  Open the storage file in the user's editor.
+
+ Returns a promise that resolves when the editor has been opened, or rejects if it failed to open.
  */
- openInEditor(): void;
+ openInEditor(): Promise<void>;
 }
 
 export = ElectronStore;

index.js

@@ -73,8 +73,12 @@ class ElectronStore extends Conf {
  initDataListener();
  }
 
- openInEditor() {
- shell.openPath(this.path);
+ async openInEditor() {
+ const error = await shell.openPath(this.path);
+
+ if (error) {
+ throw new Error(error);
+ }
  }
 }
 

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

readme.md

@@ -379,6 +379,8 @@ Get the path to the storage file.
 
 Open the storage file in the user's editor.
 
+Returns a promise that resolves when the editor has been opened, or rejects if it failed to open.
+
 ### initRenderer()
 
 Initializer to set up the required `ipc` communication channels for the module when a `Store` instance is not created in the main process and you are creating a `Store` instance in the Electron renderer process only.