Skip to content

Commit 986ccfa

Browse files
docs: document the openItem -> openPath breaking change (electron#22507)
* docs: document the openItem -> openPath breaking change * Apply suggestions from code review Co-Authored-By: Erick Zhao <erick@hotmail.ca> Co-authored-by: Erick Zhao <erick@hotmail.ca>
1 parent 479354e commit 986ccfa

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/breaking-changes.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,11 @@ In Electron 9.0, the old serialization algorithm has been removed, and sending
8484
such non-serializable objects will now throw an "object could not be cloned"
8585
error.
8686

87+
### `shell.openItem` --> `shell.openPath`
88+
89+
The `shell.openItem` API has been replaced with an asynchronous `shell.openPath` API.
90+
You can see the original API proposal and reasoning [here](https://github.com/electron/governance/blob/master/wg-api/spec-documents/shell-openitem.md).
91+
8792
## Planned Breaking API Changes (8.0)
8893

8994
### Values sent over IPC are now serialized with Structured Clone Algorithm

0 commit comments

Comments
 (0)