mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

docs: documentation of NetworkService-based protocol module (#18952)

Browse source 
* 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
This commit is contained in:
Cheng Zhao 2019-06-28 16:25:30 +09:00 • committed by GitHub
parent 127d617db5
commit 0a9438dbba
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 451 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/api/structures/protocol-request.md Normal file
View file

@ -0,0 +1,6 @@
# ProtocolRequest Object
* `url` String
* `referrer` String
* `method` String
* `uploadData` [UploadData[]](upload-data.md) (optional)

36
docs/api/structures/protocol-response.md Normal file
View file

@ -0,0 +1,36 @@
# ProtocolResponse Object
* `error` Integer (optional) - When assigned, the `request` will fail with the
`error` number . For the available error numbers you can use, please see the
[net error list][net-error].
* `statusCode` Number (optional) - The HTTP response code, default is 200.
* `charset` String (optional) - The charset of response body, default is
`"utf-8"`.
* `mimeType` String (optional) - The MIME type of response body, default is
`"text/html"`. Setting `mimeType` would implicitly set the `content-type`
header in response, but if `content-type` is already set in `headers`, the
`mimeType` would be ignored.
* `headers` Record<string, string | string[]> (optional) - An object containing the response headers. The
keys must be String, and values must be either String or Array of String.
* `data` (Buffer | String | ReadableStream) (optional) - The response body. When
returning stream as response, this is a Node.js readable stream representing
the response body. When returning `Buffer` as response, this is a `Buffer`.
When returning `String` as response, this is a `String`. This is ignored for
other types of responses.
* `path` String (optional) - Path to the file which would be sent as response
body. This is only used for file responses.
* `url` String (optional) - Download the `url` and pipe the result as response
body. This is only used for URL responses.
* `referrer` String (optional) - The `referrer` URL. This is only used for file
and URL responses.
* `method` String (optional) - The HTTP `method`. This is only used for file
and URL responses.
* `session` Session (optional) - The session used for requesting URL, by default
the HTTP request will reuse the current session. Setting `session` to `null`
would use a random independent session. This is only used for URL responses.
* `uploadData` Object (optional) - The data used as upload data. This is only
used for URL responses when `method` is `"POST"`.
* `contentType` String - MIME type of the content.
* `data` String - Content to be sent.
[net-error]: https://code.google.com/p/chromium/codesearch#chromium/src/net/base/net_error_list.h