Browse Source

docs: document the openItem -> openPath breaking change (#22507)

* docs: document the openItem -> openPath breaking change

* Apply suggestions from code review

Co-Authored-By: Erick Zhao <[email protected]>

Co-authored-by: Erick Zhao <[email protected]>
Samuel Attard 5 years ago
parent
commit
986ccfa816
1 changed files with 5 additions and 0 deletions
  1. 5 0
      docs/breaking-changes.md

+ 5 - 0
docs/breaking-changes.md

@@ -84,6 +84,11 @@ In Electron 9.0, the old serialization algorithm has been removed, and sending
 such non-serializable objects will now throw an "object could not be cloned"
 error.
 
+### `shell.openItem` --> `shell.openPath`
+
+The `shell.openItem` API has been replaced with an asynchronous `shell.openPath` API.
+You can see the original API proposal and reasoning [here](https://github.com/electron/governance/blob/master/wg-api/spec-documents/shell-openitem.md).
+
 ## Planned Breaking API Changes (8.0)
 
 ### Values sent over IPC are now serialized with Structured Clone Algorithm