From 09afaec9de0ba98b060a1ea5b6ebdd5f26861e41 Mon Sep 17 00:00:00 2001 From: Milan Burda Date: Wed, 14 Oct 2020 19:17:07 +0200 Subject: [PATCH] docs: move breaking-changes-ns.md contents to breaking-changes.md (#25921) --- docs/breaking-changes-ns.md | 61 ------------------------------------- docs/breaking-changes.md | 48 +++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+), 61 deletions(-) delete mode 100644 docs/breaking-changes-ns.md diff --git a/docs/breaking-changes-ns.md b/docs/breaking-changes-ns.md deleted file mode 100644 index 1914c1f43f44..000000000000 --- a/docs/breaking-changes-ns.md +++ /dev/null @@ -1,61 +0,0 @@ -# Breaking changes (NetworkService) (Draft) - -This document describes changes to Electron APIs after migrating network code -to NetworkService API. - -We don't currently have an estimate of when we will enable `NetworkService` by -default in Electron, but as Chromium is already removing non-`NetworkService` -code, we might switch before Electron 10. - -The content of this document should be moved to `breaking-changes.md` once we have -determined when to enable `NetworkService` in Electron. - -## Planned Breaking API Changes - -### `protocol.unregisterProtocol` -### `protocol.uninterceptProtocol` - -The APIs are now synchronous and the optional callback is no longer needed. - -```javascript -// Deprecated -protocol.unregisterProtocol(scheme, () => { /* ... */ }) -// Replace with -protocol.unregisterProtocol(scheme) -``` - -### `protocol.registerFileProtocol` -### `protocol.registerBufferProtocol` -### `protocol.registerStringProtocol` -### `protocol.registerHttpProtocol` -### `protocol.registerStreamProtocol` -### `protocol.interceptFileProtocol` -### `protocol.interceptStringProtocol` -### `protocol.interceptBufferProtocol` -### `protocol.interceptHttpProtocol` -### `protocol.interceptStreamProtocol` - -The APIs are now synchronous and the optional callback is no longer needed. - -```javascript -// Deprecated -protocol.registerFileProtocol(scheme, handler, () => { /* ... */ }) -// Replace with -protocol.registerFileProtocol(scheme, handler) -``` - -The registered or intercepted protocol does not have effect on current page -until navigation happens. - -### `protocol.isProtocolHandled` - -This API is deprecated and users should use `protocol.isProtocolRegistered` -and `protocol.isProtocolIntercepted` instead. - -```javascript -// Deprecated -protocol.isProtocolHandled(scheme).then(() => { /* ... */ }) -// Replace with -const isRegistered = protocol.isProtocolRegistered(scheme) -const isIntercepted = protocol.isProtocolIntercepted(scheme) -``` diff --git a/docs/breaking-changes.md b/docs/breaking-changes.md index 27cc43aea658..990c12ba5984 100644 --- a/docs/breaking-changes.md +++ b/docs/breaking-changes.md @@ -178,6 +178,54 @@ const w = new BrowserWindow({ We [recommend moving away from the remote module](https://medium.com/@nornagon/electrons-remote-module-considered-harmful-70d69500f31). +### `protocol.unregisterProtocol` +### `protocol.uninterceptProtocol` + +The APIs are now synchronous and the optional callback is no longer needed. + +```javascript +// Deprecated +protocol.unregisterProtocol(scheme, () => { /* ... */ }) +// Replace with +protocol.unregisterProtocol(scheme) +``` + +### `protocol.registerFileProtocol` +### `protocol.registerBufferProtocol` +### `protocol.registerStringProtocol` +### `protocol.registerHttpProtocol` +### `protocol.registerStreamProtocol` +### `protocol.interceptFileProtocol` +### `protocol.interceptStringProtocol` +### `protocol.interceptBufferProtocol` +### `protocol.interceptHttpProtocol` +### `protocol.interceptStreamProtocol` + +The APIs are now synchronous and the optional callback is no longer needed. + +```javascript +// Deprecated +protocol.registerFileProtocol(scheme, handler, () => { /* ... */ }) +// Replace with +protocol.registerFileProtocol(scheme, handler) +``` + +The registered or intercepted protocol does not have effect on current page +until navigation happens. + +### `protocol.isProtocolHandled` + +This API is deprecated and users should use `protocol.isProtocolRegistered` +and `protocol.isProtocolIntercepted` instead. + +```javascript +// Deprecated +protocol.isProtocolHandled(scheme).then(() => { /* ... */ }) +// Replace with +const isRegistered = protocol.isProtocolRegistered(scheme) +const isIntercepted = protocol.isProtocolIntercepted(scheme) +``` + ## Planned Breaking API Changes (9.0) ### Default Changed: Loading non-context-aware native modules in the renderer process is disabled by default