docs: Revise the webRequest and protocol docs
This commit is contained in:
parent
30ff18ac64
commit
f820b0db83
2 changed files with 47 additions and 12 deletions
|
@ -54,6 +54,19 @@ going to be created with `scheme`. `completion` will be called with
|
||||||
`completion(null)` when `scheme` is successfully registered or
|
`completion(null)` when `scheme` is successfully registered or
|
||||||
`completion(error)` when failed.
|
`completion(error)` when failed.
|
||||||
|
|
||||||
|
* `request` Object
|
||||||
|
* `url` String
|
||||||
|
* `referrer` String
|
||||||
|
* `method` String
|
||||||
|
* `uploadData` Array (optional)
|
||||||
|
* `callback` Function
|
||||||
|
|
||||||
|
The `uploadData` is an array of `data` objects:
|
||||||
|
|
||||||
|
* `data` Object
|
||||||
|
* `bytes` Buffer - Content being sent.
|
||||||
|
* `file` String - Path of file being uploaded.
|
||||||
|
|
||||||
To handle the `request`, the `callback` should be called with either the file's
|
To handle the `request`, the `callback` should be called with either the file's
|
||||||
path or an object that has a `path` property, e.g. `callback(filePath)` or
|
path or an object that has a `path` property, e.g. `callback(filePath)` or
|
||||||
`callback({path: filePath})`.
|
`callback({path: filePath})`.
|
||||||
|
@ -61,7 +74,7 @@ path or an object that has a `path` property, e.g. `callback(filePath)` or
|
||||||
When `callback` is called with nothing, a number, or an object that has an
|
When `callback` is called with nothing, a number, or an object that has an
|
||||||
`error` property, the `request` will fail with the `error` number you
|
`error` property, the `request` will fail with the `error` number you
|
||||||
specified. For the available error numbers you can use, please see the
|
specified. For the available error numbers you can use, please see the
|
||||||
[net error list](https://code.google.com/p/chromium/codesearch#chromium/src/net/base/net_error_list.h).
|
[net error list][net-error].
|
||||||
|
|
||||||
By default the `scheme` is treated like `http:`, which is parsed differently
|
By default the `scheme` is treated like `http:`, which is parsed differently
|
||||||
than protocols that follow the "generic URI syntax" like `file:`, so you
|
than protocols that follow the "generic URI syntax" like `file:`, so you
|
||||||
|
@ -74,9 +87,11 @@ treated as a standard scheme.
|
||||||
* `handler` Function
|
* `handler` Function
|
||||||
* `completion` Function (optional)
|
* `completion` Function (optional)
|
||||||
|
|
||||||
Registers a protocol of `scheme` that will send a `Buffer` as a response. The
|
Registers a protocol of `scheme` that will send a `Buffer` as a response.
|
||||||
`callback` should be called with either a `Buffer` object or an object that
|
|
||||||
has the `data`, `mimeType`, and `chart` properties.
|
The usage is the same with `registerFileProtocol`, except that the `callback`
|
||||||
|
should be called with either a `Buffer` object or an object that has the `data`,
|
||||||
|
`mimeType`, and `charset` properties.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
|
@ -95,9 +110,11 @@ protocol.registerBufferProtocol('atom', function(request, callback) {
|
||||||
* `handler` Function
|
* `handler` Function
|
||||||
* `completion` Function (optional)
|
* `completion` Function (optional)
|
||||||
|
|
||||||
Registers a protocol of `scheme` that will send a `String` as a response. The
|
Registers a protocol of `scheme` that will send a `String` as a response.
|
||||||
`callback` should be called with either a `String` or an object that has the
|
|
||||||
`data`, `mimeType`, and `chart` properties.
|
The usage is the same with `registerFileProtocol`, except that the `callback`
|
||||||
|
should be called with either a `String` or an object that has the `data`,
|
||||||
|
`mimeType`, and `charset` properties.
|
||||||
|
|
||||||
### `protocol.registerHttpProtocol(scheme, handler[, completion])`
|
### `protocol.registerHttpProtocol(scheme, handler[, completion])`
|
||||||
|
|
||||||
|
@ -106,13 +123,22 @@ Registers a protocol of `scheme` that will send a `String` as a response. The
|
||||||
* `completion` Function (optional)
|
* `completion` Function (optional)
|
||||||
|
|
||||||
Registers a protocol of `scheme` that will send an HTTP request as a response.
|
Registers a protocol of `scheme` that will send an HTTP request as a response.
|
||||||
The `callback` should be called with an object that has the `url`, `method`,
|
|
||||||
|
The usage is the same with `registerFileProtocol`, except that the `callback`
|
||||||
|
should be called with a `redirectRequest` object that has the `url`, `method`,
|
||||||
`referrer`, `uploadData` and `session` properties.
|
`referrer`, `uploadData` and `session` properties.
|
||||||
|
|
||||||
|
* `redirectRequest` Object
|
||||||
|
* `url` String
|
||||||
|
* `method` String
|
||||||
|
* `session` Object (optional)
|
||||||
|
* `uploadData` Object
|
||||||
|
|
||||||
By default the HTTP request will reuse the current session. If you want the
|
By default the HTTP request will reuse the current session. If you want the
|
||||||
request to have a different session you should set `session` to `null`.
|
request to have a different session you should set `session` to `null`.
|
||||||
|
|
||||||
POST request should provide an `uploadData` object.
|
For POST requests the `uploadData` object must be provided.
|
||||||
|
|
||||||
* `uploadData` object
|
* `uploadData` object
|
||||||
* `contentType` String - MIME type of the content.
|
* `contentType` String - MIME type of the content.
|
||||||
* `data` String - Content to be sent.
|
* `data` String - Content to be sent.
|
||||||
|
@ -174,3 +200,5 @@ which sends a new HTTP request as a response.
|
||||||
* `completion` Function
|
* `completion` Function
|
||||||
|
|
||||||
Remove the interceptor installed for `scheme` and restore its original handler.
|
Remove the interceptor installed for `scheme` and restore its original handler.
|
||||||
|
|
||||||
|
[net-error]: https://code.google.com/p/chromium/codesearch#chromium/src/net/base/net_error_list.h
|
||||||
|
|
|
@ -333,6 +333,11 @@ is about to occur.
|
||||||
* `resourceType` String
|
* `resourceType` String
|
||||||
* `timestamp` Double
|
* `timestamp` Double
|
||||||
* `uploadData` Array (optional)
|
* `uploadData` Array (optional)
|
||||||
|
* `callback` Function
|
||||||
|
|
||||||
|
The `uploadData` is an array of `data` objects:
|
||||||
|
|
||||||
|
* `data` Object
|
||||||
* `bytes` Buffer - Content being sent.
|
* `bytes` Buffer - Content being sent.
|
||||||
* `file` String - Path of file being uploaded.
|
* `file` String - Path of file being uploaded.
|
||||||
|
|
||||||
|
@ -359,6 +364,7 @@ TCP connection is made to the server, but before any http data is sent.
|
||||||
* `resourceType` String
|
* `resourceType` String
|
||||||
* `timestamp` Double
|
* `timestamp` Double
|
||||||
* `requestHeaders` Object
|
* `requestHeaders` Object
|
||||||
|
* `callback` Function
|
||||||
|
|
||||||
The `callback` has to be called with an `response` object:
|
The `callback` has to be called with an `response` object:
|
||||||
|
|
||||||
|
@ -401,6 +407,7 @@ response headers of a request have been received.
|
||||||
* `statusLine` String
|
* `statusLine` String
|
||||||
* `statusCode` Integer
|
* `statusCode` Integer
|
||||||
* `responseHeaders` Object
|
* `responseHeaders` Object
|
||||||
|
* `callback` Function
|
||||||
|
|
||||||
The `callback` has to be called with an `response` object:
|
The `callback` has to be called with an `response` object:
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue