Browse Source

docs: move breaking-changes-ns.md contents to breaking-changes.md (#25947)

Co-authored-by: Milan Burda <[email protected]>
trop[bot] 4 years ago
parent
commit
ca163f9cf7
2 changed files with 48 additions and 61 deletions
  1. 0 61
      docs/breaking-changes-ns.md
  2. 48 0
      docs/breaking-changes.md

+ 0 - 61
docs/breaking-changes-ns.md

@@ -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)
-```

+ 48 - 0
docs/breaking-changes.md

@@ -133,6 +133,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