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

docs: type names changed from wrapper to primitive (#31752)

Browse source
This commit is contained in:
Milan Burda 2021-11-16 05:13:18 +01:00 • committed by GitHub
parent 246884c4fb
commit e6b1d95a1c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
115 changed files with 1685 additions and 1685 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/api/structures/protocol-response.md
View file

@ -3,27 +3,27 @@
* `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
* `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
* `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
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
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
* `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
* `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
* `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
* `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`