0a9438dbba
* docs: NetworkService-based protocol module * docs: separate ProtocolRequest * docs: separate ProtocolResponse * docs: fix lint warning * docs: fix electron.d.ts * fix: print deprecation warnings for protocol module * docs: fix links * Apply suggestions from code review Co-Authored-By: Felix Rieseberg <felix@felixrieseberg.com> * Apply suggestions from code review Co-Authored-By: Samuel Attard <samuel.r.attard@gmail.com> * Do not publish NetworkService changes draft * Apply suggestions from code review Co-Authored-By: Samuel Attard <samuel.r.attard@gmail.com> * docs: filePath must be absolute
61 lines
1.9 KiB
Markdown
61 lines
1.9 KiB
Markdown
# 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)
|
|
```
|