github/electron
1
1
Fork 0
mirror of https://github.com/electron/electron.git synced 2026-01-26 15:58:07 -05:00
Code Issues Packages Projects Releases Wiki Activity

Reorder the version sections newest-to-oldest

Browse Source 
This puts 4.0 before 3.0, making room to re-add
the 2.0 changes back in at the end of the file.
This commit is contained in:
Charles Kerr
2018-05-29 11:17:26 +02:00
parent 7f64dbc1ba
commit 57ad506cde
1 changed files with 31 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
docs/api/breaking-changes.md
View File

@@ -7,6 +7,37 @@ Breaking changes will be included in this documentation, and deprecation warning
The `FIXME` string is used in code comments to denote things that should be fixed for future releases. See https://github.com/electron/electron/search?q=fixme
# Planned Breaking API Changes (4.0)
The following list includes the APIs that will be removed in Electron 4.0.
There is no timetable for when this release will occur but deprecation
warnings will be added at least [one major version](electron-versioning.md#semver) beforehand.
## `app.makeSingleInstance`
```js
// Deprecated
app.makeSingleInstance(function (argv, cwd) {
})
// Replace with
app.requestSingleInstanceLock()
app.on('second-instance', function (argv, cwd) {
})
```
## `app.releaseSingleInstance`
```js
// Deprecated
app.releaseSingleInstance()
// Replace with
app.releaseSingleInstanceLock()
```
# Planned Breaking API Changes (3.0)
The following list includes the APIs that will be removed in Electron 3.0.
@@ -164,33 +195,3 @@ Deprecated: https://atom.io/download/atom-shell
Replace with: https://atom.io/download/electron
# Planned Breaking API Changes (4.0)
The following list includes the APIs that will be removed in Electron 4.0.
There is no timetable for when this release will occur but deprecation
warnings will be added at least [one major version](electron-versioning.md#semver) beforehand.
## `app.makeSingleInstance`
```js
// Deprecated
app.makeSingleInstance(function (argv, cwd) {
})
// Replace with
app.requestSingleInstanceLock()
app.on('second-instance', function (argv, cwd) {
})
```
## `app.releaseSingleInstance`
```js
// Deprecated
app.releaseSingleInstance()
// Replace with
app.releaseSingleInstanceLock()
```