electron/docs/api/protocol.md

# protocol

> Register a custom protocol and intercept existing protocol requests.

Process: [Main](../glossary.md#main-process)

An example of implementing a protocol that has the same effect as the
`file://` protocol:

```javascript
const {app, protocol} = require('electron')
const path = require('path')

app.on('ready', () => {
  protocol.registerFileProtocol('atom', (request, callback) => {
    const url = request.url.substr(7)
    callback({path: path.normalize(`${__dirname}/${url}`)})
  }, (error) => {
    if (error) console.error('Failed to register protocol')
  })
})
```

**Note:** All methods unless specified can only be used after the `ready` event
of the `app` module gets emitted.

## Methods

The `protocol` module has the following methods:

### `protocol.registerStandardSchemes(schemes[, options])`

* `schemes` String[] - Custom schemes to be registered as standard schemes.
* `options` Object (optional)
  * `secure` Boolean (optional) - `true` to register the scheme as secure.
    Default `false`.

A standard scheme adheres to what RFC 3986 calls [generic URI
syntax](https://tools.ietf.org/html/rfc3986#section-3). For example `http` and
`https` are standard schemes, while `file` is not.

Registering a scheme as standard, will allow relative and absolute resources to
be resolved correctly when served. Otherwise the scheme will behave like the
`file` protocol, but without the ability to resolve relative URLs.

For example when you load following page with custom protocol without
registering it as standard scheme, the image will not be loaded because
non-standard schemes can not recognize relative URLs:

```html
<body>
  <img src='test.png'>
</body>
```

Registering a scheme as standard will allow access to files through the
[FileSystem API][file-system-api]. Otherwise the renderer will throw a security
error for the scheme.

By default web storage apis (localStorage, sessionStorage, webSQL, indexedDB, cookies)
are disabled for non standard schemes. So in general if you want to register a
custom protocol to replace the `http` protocol, you have to register it as a standard scheme:

```javascript
const {app, protocol} = require('electron')

protocol.registerStandardSchemes(['atom'])
app.on('ready', () => {
  protocol.registerHttpProtocol('atom', '...')
})
```

**Note:** This method can only be used before the `ready` event of the `app`
module gets emitted.

### `protocol.registerServiceWorkerSchemes(schemes)`

* `schemes` String[] - Custom schemes to be registered to handle service workers.

### `protocol.registerFileProtocol(scheme, handler[, completion])`

* `scheme` String
* `handler` Function
  * `request` Object
    * `url` String
    * `referrer` String
    * `method` String
    * `uploadData` [UploadData[]](structures/upload-data.md)
  * `callback` Function
    * `filePath` String (optional)
* `completion` Function (optional)
  * `error` Error

Registers a protocol of `scheme` that will send the file as a response. The
`handler` will be called with `handler(request, callback)` when a `request` is
going to be created with `scheme`. `completion` will be called with
`completion(null)` when `scheme` is successfully registered or
`completion(error)` when failed.

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
`callback({path: filePath})`.

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
specified. For the available error numbers you can use, please see the
[net error list][net-error].

By default the `scheme` is treated like `http:`, which is parsed differently
than protocols that follow the "generic URI syntax" like `file:`, so you
probably want to call `protocol.registerStandardSchemes` to have your scheme
treated as a standard scheme.

### `protocol.registerBufferProtocol(scheme, handler[, completion])`

* `scheme` String
* `handler` Function
  * `request` Object
    * `url` String
    * `referrer` String
    * `method` String
    * `uploadData` [UploadData[]](structures/upload-data.md)
  * `callback` Function
    * `buffer` (Buffer | [MimeTypedBuffer](structures/mime-typed-buffer.md)) (optional)
* `completion` Function (optional)
  * `error` Error

Registers a protocol of `scheme` that will send a `Buffer` as a response.

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:

```javascript
const {protocol} = require('electron')

protocol.registerBufferProtocol('atom', (request, callback) => {
  callback({mimeType: 'text/html', data: Buffer.from('<h5>Response</h5>')})
}, (error) => {
  if (error) console.error('Failed to register protocol')
})
```

### `protocol.registerStringProtocol(scheme, handler[, completion])`

* `scheme` String
* `handler` Function
  * `request` Object
    * `url` String
    * `referrer` String
    * `method` String
    * `uploadData` [UploadData[]](structures/upload-data.md)
  * `callback` Function
    * `data` String (optional)
* `completion` Function (optional)
  * `error` Error

Registers a protocol of `scheme` that will send a `String` as a response.

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

* `scheme` String
* `handler` Function
  * `request` Object
    * `url` String
    * `referrer` String
    * `method` String
    * `uploadData` [UploadData[]](structures/upload-data.md)
  * `callback` Function
    * `redirectRequest` Object
      * `url` String
      * `method` String
      * `session` Object (optional)
      * `uploadData` Object (optional)
        * `contentType` String - MIME type of the content.
        * `data` String - Content to be sent.
* `completion` Function (optional)
  * `error` Error

Registers a protocol of `scheme` that will send an HTTP request as a response.

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.

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`.

For POST requests the `uploadData` object must be provided.

### `protocol.unregisterProtocol(scheme[, completion])`

* `scheme` String
* `completion` Function (optional)
  * `error` Error

Unregisters the custom protocol of `scheme`.

### `protocol.isProtocolHandled(scheme, callback)`

* `scheme` String
* `callback` Function
  * `error` Error

The `callback` will be called with a boolean that indicates whether there is
already a handler for `scheme`.

### `protocol.interceptFileProtocol(scheme, handler[, completion])`

* `scheme` String
* `handler` Function
  * `request` Object
    * `url` String
    * `referrer` String
    * `method` String
    * `uploadData` [UploadData[]](structures/upload-data.md)
  * `callback` Function
    * `filePath` String
* `completion` Function (optional)
  * `error` Error

Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
which sends a file as a response.

### `protocol.interceptStringProtocol(scheme, handler[, completion])`

* `scheme` String
* `handler` Function
  * `request` Object
    * `url` String
    * `referrer` String
    * `method` String
    * `uploadData` [UploadData[]](structures/upload-data.md)
  * `callback` Function
    * `data` String (optional)
* `completion` Function (optional)
  * `error` Error

Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
which sends a `String` as a response.

### `protocol.interceptBufferProtocol(scheme, handler[, completion])`

* `scheme` String
* `handler` Function
  * `request` Object
    * `url` String
    * `referrer` String
    * `method` String
    * `uploadData` [UploadData[]](structures/upload-data.md)
  * `callback` Function
    * `buffer` Buffer (optional)
* `completion` Function (optional)
  * `error` Error

Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
which sends a `Buffer` as a response.

### `protocol.interceptHttpProtocol(scheme, handler[, completion])`

* `scheme` String
* `handler` Function
  * `request` Object
    * `url` String
    * `referrer` String
    * `method` String
    * `uploadData` [UploadData[]](structures/upload-data.md)
  * `callback` Function
    * `redirectRequest` Object
      * `url` String
      * `method` String
      * `session` Object (optional)
      * `uploadData` Object (optional)
        * `contentType` String - MIME type of the content.
        * `data` String - Content to be sent.
* `completion` Function (optional)
  * `error` Error

Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
which sends a new HTTP request as a response.

### `protocol.uninterceptProtocol(scheme[, completion])`

* `scheme` String
* `completion` Function (optional)
  * `error` Error

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
[file-system-api]: https://developer.mozilla.org/en-US/docs/Web/API/LocalFileSystem
doc: Add titles for all pages. 2013-09-09 15:35:57 +08:00			`# protocol`
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00
more updates to api summaries based on feedback 2016-04-22 11:42:54 -07:00			`> Register a custom protocol and intercept existing protocol requests.`
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00
link process annotations to glossary 2016-11-23 11:20:56 -08:00			`Process: [Main](../glossary.md#main-process)`
document process(es) for all APIs 2016-11-03 10:26:00 -07:00
Standardize protocol 2015-08-28 22:03:39 -07:00			`An example of implementing a protocol that has the same effect as the`
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00			`file://` protocol:

			```javascript
standardize all javascript blocks in English docs 2016-07-25 18:39:25 -07:00			`const {app, protocol} = require('electron')`
			`const path = require('path')`
docs: When to use protocol.registerStandardSchemes 2016-05-09 10:20:08 +09:00
:memo: Fix code style issue * Change `var` to `let`. * Change `function() {}` to `() => {}`. * Use shorthand function syntax on object notation. * Remove spaces between object notation brackets. * Small fixes. 2016-05-11 02:15:09 +09:00			`app.on('ready', () => {`
			`protocol.registerFileProtocol('atom', (request, callback) => {`
standardize all javascript blocks in English docs 2016-07-25 18:39:25 -07:00			`const url = request.url.substr(7)`
			callback({path: path.normalize(`${__dirname}/${url}`)})
:memo: Fix code style issue * Change `var` to `let`. * Change `function() {}` to `() => {}`. * Use shorthand function syntax on object notation. * Remove spaces between object notation brackets. * Small fixes. 2016-05-11 02:15:09 +09:00			`}, (error) => {`
standardize all javascript blocks in English docs 2016-07-25 18:39:25 -07:00			`if (error) console.error('Failed to register protocol')`
			`})`
			`})`
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00			```
standardize all javascript blocks in English docs 2016-07-25 18:39:25 -07:00
docs: When to use protocol.registerStandardSchemes 2016-05-09 10:20:08 +09:00			Note: All methods unless specified can only be used after the `ready` event
			of the `app` module gets emitted.
doc: Mention when protocol module is safe to use. 2013-09-20 18:36:16 +08:00
Standardize protocol 2015-08-28 22:03:39 -07:00			`## Methods`

			The `protocol` module has the following methods:

Add options to protocol.registerStandardSchemes docs 2016-12-20 09:43:12 -08:00			### `protocol.registerStandardSchemes(schemes[, options])`
docs: Rewrite docs for new protocol API 2015-08-14 13:44:18 +08:00
Update docs to contain more specific return values 2016-09-28 18:28:44 +13:00			* `schemes` String[] - Custom schemes to be registered as standard schemes.
Add options to protocol.registerStandardSchemes docs 2016-12-20 09:43:12 -08:00			* `options` Object (optional)
			* `secure` Boolean (optional) - `true` to register the scheme as secure.
			Default `false`.
docs: Rewrite docs for new protocol API 2015-08-14 13:44:18 +08:00
docs: When to use protocol.registerStandardSchemes 2016-05-09 10:20:08 +09:00			`A standard scheme adheres to what RFC 3986 calls [generic URI`
			syntax](https://tools.ietf.org/html/rfc3986#section-3). For example `http` and
			`https` are standard schemes, while `file` is not.

			`Registering a scheme as standard, will allow relative and absolute resources to`
			`be resolved correctly when served. Otherwise the scheme will behave like the`
			`file` protocol, but without the ability to resolve relative URLs.

			`For example when you load following page with custom protocol without`
			`registering it as standard scheme, the image will not be loaded because`
			`non-standard schemes can not recognize relative URLs:`

			```html
			`<body>`
			`<img src='test.png'>`
			`</body>`
			```
Minor doc edits and link to MDN page 2016-08-24 09:03:44 -07:00
			`Registering a scheme as standard will allow access to files through the`
			`[FileSystem API][file-system-api]. Otherwise the renderer will throw a security`
update docs 2016-09-22 00:20:34 +05:30			`error for the scheme.`

			`By default web storage apis (localStorage, sessionStorage, webSQL, indexedDB, cookies)`
			`are disabled for non standard schemes. So in general if you want to register a`
			custom protocol to replace the `http` protocol, you have to register it as a standard scheme:
docs: When to use protocol.registerStandardSchemes 2016-05-09 10:20:08 +09:00
			```javascript
standardize all javascript blocks in English docs 2016-07-25 18:39:25 -07:00			`const {app, protocol} = require('electron')`

			`protocol.registerStandardSchemes(['atom'])`
:memo: Fix code style issue * Change `var` to `let`. * Change `function() {}` to `() => {}`. * Use shorthand function syntax on object notation. * Remove spaces between object notation brackets. * Small fixes. 2016-05-11 02:15:09 +09:00			`app.on('ready', () => {`
standardize all javascript blocks in English docs 2016-07-25 18:39:25 -07:00			`protocol.registerHttpProtocol('atom', '...')`
			`})`
docs: When to use protocol.registerStandardSchemes 2016-05-09 10:20:08 +09:00			```
fix docs and spec 2016-05-08 01:31:04 +05:30
docs: When to use protocol.registerStandardSchemes 2016-05-09 10:20:08 +09:00			Note: This method can only be used before the `ready` event of the `app`
			`module gets emitted.`
docs: Rewrite docs for new protocol API 2015-08-14 13:44:18 +08:00
protocol: api to register schemes that can handle service worker 2015-12-09 00:51:46 +05:30			### `protocol.registerServiceWorkerSchemes(schemes)`

Update docs to contain more specific return values 2016-09-28 18:28:44 +13:00			* `schemes` String[] - Custom schemes to be registered to handle service workers.
protocol: api to register schemes that can handle service worker 2015-12-09 00:51:46 +05:30
Standardize protocol 2015-08-28 22:03:39 -07:00			### `protocol.registerFileProtocol(scheme, handler[, completion])`
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00
			* `scheme` String
			* `handler` Function
Specifiy function param types in docs 2016-10-13 17:30:57 +11:00			* `request` Object
			* `url` String
			* `referrer` String
			* `method` String
			* `uploadData` [UploadData[]](structures/upload-data.md)
			* `callback` Function
			* `filePath` String (optional)
Standardize protocol 2015-08-28 22:03:39 -07:00			* `completion` Function (optional)
Specifiy function param types in docs 2016-10-13 17:30:57 +11:00			* `error` Error
docs: Rewrite docs for new protocol API 2015-08-14 13:44:18 +08:00
Text edits 2015-09-01 19:08:31 -07:00			Registers a protocol of `scheme` that will send the file as a response. The
			`handler` will be called with `handler(request, callback)` when a `request` is
			going to be created with `scheme`. `completion` will be called with
			`completion(null)` when `scheme` is successfully registered or
			`completion(error)` when failed.
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00
Standardize protocol 2015-08-28 22:03:39 -07:00			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
docs: Rewrite docs for new protocol API 2015-08-14 13:44:18 +08:00			`callback({path: filePath})`.
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00
Standardize protocol 2015-08-28 22:03:39 -07:00			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
Text edits 2015-09-01 19:08:31 -07:00			`specified. For the available error numbers you can use, please see the`
docs: Revise the webRequest and protocol docs 2016-01-28 18:59:07 +08:00			`[net error list][net-error].`
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00
Standardize protocol 2015-08-28 22:03:39 -07:00			By default the `scheme` is treated like `http:`, which is parsed differently
Text edits 2015-09-01 19:08:31 -07:00			than protocols that follow the "generic URI syntax" like `file:`, so you
			probably want to call `protocol.registerStandardSchemes` to have your scheme
			`treated as a standard scheme.`
docs: Say more about standard scheme 2015-07-16 06:32:09 -07:00
Standardize protocol 2015-08-28 22:03:39 -07:00			### `protocol.registerBufferProtocol(scheme, handler[, completion])`
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00
			* `scheme` String
docs: Rewrite docs for new protocol API 2015-08-14 13:44:18 +08:00			* `handler` Function
Specifiy function param types in docs 2016-10-13 17:30:57 +11:00			* `request` Object
			* `url` String
			* `referrer` String
			* `method` String
			* `uploadData` [UploadData[]](structures/upload-data.md)
			* `callback` Function
Update docs for dts again 2016-11-25 23:17:31 +11:00			* `buffer` (Buffer \| [MimeTypedBuffer](structures/mime-typed-buffer.md)) (optional)
Standardize protocol 2015-08-28 22:03:39 -07:00			* `completion` Function (optional)
Specifiy function param types in docs 2016-10-13 17:30:57 +11:00			* `error` Error
protocol: api to register custom schemes to standard schemes 2015-06-12 13:28:23 +05:30
docs: Revise the webRequest and protocol docs 2016-01-28 18:59:07 +08:00			Registers a protocol of `scheme` that will send a `Buffer` as a response.

			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.
protocol: api to register custom schemes to standard schemes 2015-06-12 13:28:23 +05:30
docs: Rewrite docs for new protocol API 2015-08-14 13:44:18 +08:00			`Example:`
docs: Say more about standard scheme 2015-07-16 06:32:09 -07:00
docs: Rewrite docs for new protocol API 2015-08-14 13:44:18 +08:00			```javascript
standardize all javascript blocks in English docs 2016-07-25 18:39:25 -07:00			`const {protocol} = require('electron')`

:memo: Update API documentation to ES6 [ci skip] 2016-05-04 11:59:02 -06:00			`protocol.registerBufferProtocol('atom', (request, callback) => {`
use new Buffer.from 2017-06-10 12:22:27 -07:00			`callback({mimeType: 'text/html', data: Buffer.from('<h5>Response</h5>')})`
:memo: Update API documentation to ES6 [ci skip] 2016-05-04 11:59:02 -06:00			`}, (error) => {`
standardize all javascript blocks in English docs 2016-07-25 18:39:25 -07:00			`if (error) console.error('Failed to register protocol')`
			`})`
docs: Rewrite docs for new protocol API 2015-08-14 13:44:18 +08:00			```
protocol: api to register custom schemes to standard schemes 2015-06-12 13:28:23 +05:30
Standardize protocol 2015-08-28 22:03:39 -07:00			### `protocol.registerStringProtocol(scheme, handler[, completion])`
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00
			* `scheme` String
docs: Rewrite docs for new protocol API 2015-08-14 13:44:18 +08:00			* `handler` Function
Specifiy function param types in docs 2016-10-13 17:30:57 +11:00			* `request` Object
			* `url` String
			* `referrer` String
			* `method` String
			* `uploadData` [UploadData[]](structures/upload-data.md)
			* `callback` Function
			* `data` String (optional)
Standardize protocol 2015-08-28 22:03:39 -07:00			* `completion` Function (optional)
Specifiy function param types in docs 2016-10-13 17:30:57 +11:00			* `error` Error
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00
docs: Revise the webRequest and protocol docs 2016-01-28 18:59:07 +08:00			Registers a protocol of `scheme` that will send a `String` as a response.

			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.
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00
Standardize protocol 2015-08-28 22:03:39 -07:00			### `protocol.registerHttpProtocol(scheme, handler[, completion])`
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00
			* `scheme` String
			* `handler` Function
Specifiy function param types in docs 2016-10-13 17:30:57 +11:00			* `request` Object
			* `url` String
			* `referrer` String
			* `method` String
			* `uploadData` [UploadData[]](structures/upload-data.md)
			* `callback` Function
			* `redirectRequest` Object
			* `url` String
			* `method` String
			* `session` Object (optional)
			* `uploadData` Object (optional)
			* `contentType` String - MIME type of the content.
			* `data` String - Content to be sent.
Standardize protocol 2015-08-28 22:03:39 -07:00			* `completion` Function (optional)
Specifiy function param types in docs 2016-10-13 17:30:57 +11:00			* `error` Error
docs: Rewrite docs for new protocol API 2015-08-14 13:44:18 +08:00
Standardize protocol 2015-08-28 22:03:39 -07:00			Registers a protocol of `scheme` that will send an HTTP request as a response.
docs: Revise the webRequest and protocol docs 2016-01-28 18:59:07 +08:00
			The usage is the same with `registerFileProtocol`, except that the `callback`
			should be called with a `redirectRequest` object that has the `url`, `method`,
provide option to set content for POST request with url_fetcher 2015-12-06 15:27:02 -05:00			`referrer`, `uploadData` and `session` properties.
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00
Standardize protocol 2015-08-28 22:03:39 -07:00			`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`.
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00
docs: Revise the webRequest and protocol docs 2016-01-28 18:59:07 +08:00			For POST requests the `uploadData` object must be provided.

Standardize protocol 2015-08-28 22:03:39 -07:00			### `protocol.unregisterProtocol(scheme[, completion])`
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00
			* `scheme` String
Standardize protocol 2015-08-28 22:03:39 -07:00			* `completion` Function (optional)
Specifiy function param types in docs 2016-10-13 17:30:57 +11:00			* `error` Error
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00
docs: Rewrite docs for new protocol API 2015-08-14 13:44:18 +08:00			Unregisters the custom protocol of `scheme`.
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00
Standardize protocol 2015-08-28 22:03:39 -07:00			### `protocol.isProtocolHandled(scheme, callback)`
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00
docs: Rewrite docs for new protocol API 2015-08-14 13:44:18 +08:00			* `scheme` String
			* `callback` Function
Specifiy function param types in docs 2016-10-13 17:30:57 +11:00			* `error` Error
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00
docs: Rewrite docs for new protocol API 2015-08-14 13:44:18 +08:00			The `callback` will be called with a boolean that indicates whether there is
			already a handler for `scheme`.
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00
Standardize protocol 2015-08-28 22:03:39 -07:00			### `protocol.interceptFileProtocol(scheme, handler[, completion])`
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00
docs: Rewrite docs for new protocol API 2015-08-14 13:44:18 +08:00			* `scheme` String
			* `handler` Function
Specifiy function param types in docs 2016-10-13 17:30:57 +11:00			* `request` Object
			* `url` String
			* `referrer` String
			* `method` String
			* `uploadData` [UploadData[]](structures/upload-data.md)
			* `callback` Function
			* `filePath` String
Standardize protocol 2015-08-28 22:03:39 -07:00			* `completion` Function (optional)
Specifiy function param types in docs 2016-10-13 17:30:57 +11:00			* `error` Error
Add documentation for protocol module. 2013-09-03 18:22:40 +08:00
Standardize protocol 2015-08-28 22:03:39 -07:00			Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
			`which sends a file as a response.`
add protocol.RequestBuffer api 2015-03-16 18:23:45 +05:30
Standardize protocol 2015-08-28 22:03:39 -07:00			### `protocol.interceptStringProtocol(scheme, handler[, completion])`
add protocol.RequestBuffer api 2015-03-16 18:23:45 +05:30
docs: Rewrite docs for new protocol API 2015-08-14 13:44:18 +08:00			* `scheme` String
			* `handler` Function
Specifiy function param types in docs 2016-10-13 17:30:57 +11:00			* `request` Object
			* `url` String
			* `referrer` String
			* `method` String
			* `uploadData` [UploadData[]](structures/upload-data.md)
			* `callback` Function
			* `data` String (optional)
Standardize protocol 2015-08-28 22:03:39 -07:00			* `completion` Function (optional)
Specifiy function param types in docs 2016-10-13 17:30:57 +11:00			* `error` Error
docs: Rewrite docs for new protocol API 2015-08-14 13:44:18 +08:00
Standardize protocol 2015-08-28 22:03:39 -07:00			Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
			which sends a `String` as a response.
add protocol.RequestBuffer api 2015-03-16 18:23:45 +05:30
docs: Fix wrong level for API titles 2015-10-08 11:14:04 +08:00			### `protocol.interceptBufferProtocol(scheme, handler[, completion])`
protocol: adding error job to log error with custom protocols 2015-05-07 13:12:35 +05:30
docs: Rewrite docs for new protocol API 2015-08-14 13:44:18 +08:00			* `scheme` String
			* `handler` Function
Specifiy function param types in docs 2016-10-13 17:30:57 +11:00			* `request` Object
			* `url` String
			* `referrer` String
			* `method` String
			* `uploadData` [UploadData[]](structures/upload-data.md)
			* `callback` Function
			* `buffer` Buffer (optional)
Standardize protocol 2015-08-28 22:03:39 -07:00			* `completion` Function (optional)
Specifiy function param types in docs 2016-10-13 17:30:57 +11:00			* `error` Error
docs: protocol.RequestHttpJob 2015-06-17 11:32:39 +08:00
Standardize protocol 2015-08-28 22:03:39 -07:00			Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
			which sends a `Buffer` as a response.
docs: protocol.RequestHttpJob 2015-06-17 11:32:39 +08:00
docs: Fix wrong level for API titles 2015-10-08 11:14:04 +08:00			### `protocol.interceptHttpProtocol(scheme, handler[, completion])`
docs: protocol.RequestHttpJob 2015-06-17 11:32:39 +08:00
docs: Rewrite docs for new protocol API 2015-08-14 13:44:18 +08:00			* `scheme` String
			* `handler` Function
Specifiy function param types in docs 2016-10-13 17:30:57 +11:00			* `request` Object
			* `url` String
			* `referrer` String
			* `method` String
			* `uploadData` [UploadData[]](structures/upload-data.md)
			* `callback` Function
			* `redirectRequest` Object
			* `url` String
			* `method` String
			* `session` Object (optional)
			* `uploadData` Object (optional)
			* `contentType` String - MIME type of the content.
			* `data` String - Content to be sent.
Standardize protocol 2015-08-28 22:03:39 -07:00			* `completion` Function (optional)
Specifiy function param types in docs 2016-10-13 17:30:57 +11:00			* `error` Error
protocol: adding error job to log error with custom protocols 2015-05-07 13:12:35 +05:30
Standardize protocol 2015-08-28 22:03:39 -07:00			Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
			`which sends a new HTTP request as a response.`
protocol: adding error job to log error with custom protocols 2015-05-07 13:12:35 +05:30
docs: Fix wrong level for API titles 2015-10-08 11:14:04 +08:00			### `protocol.uninterceptProtocol(scheme[, completion])`
protocol: adding error job to log error with custom protocols 2015-05-07 13:12:35 +05:30
docs: Rewrite docs for new protocol API 2015-08-14 13:44:18 +08:00			* `scheme` String
Specifiy function param types in docs 2016-10-13 17:30:57 +11:00			* `completion` Function (optional)
			* `error` Error

docs: Rewrite docs for new protocol API 2015-08-14 13:44:18 +08:00			Remove the interceptor installed for `scheme` and restore its original handler.
docs: Revise the webRequest and protocol docs 2016-01-28 18:59:07 +08:00
			`[net-error]: https://code.google.com/p/chromium/codesearch#chromium/src/net/base/net_error_list.h`
Minor doc edits and link to MDN page 2016-08-24 09:03:44 -07:00			`[file-system-api]: https://developer.mozilla.org/en-US/docs/Web/API/LocalFileSystem`