Fix headers
authorJessica Lord <jessica.lord@github.com>
Fri, 15 Apr 2016 03:55:43 +0000 (20:55 -0700)
committerJessica Lord <jessica.lord@github.com>
Fri, 15 Apr 2016 03:55:43 +0000 (20:55 -0700)
docs/api/session.md

index 9cccefc..758082f 100644 (file)
@@ -48,11 +48,11 @@ const session = require('electron').session;
 var ses = session.fromPartition('persist:name');
 ```
 
-### Instance Events
+## Instance Events
 
 The following events are available on instances of `Session`:
 
-#### Event: 'will-download'
+### Event: 'will-download'
 
 * `event` Event
 * `item` [DownloadItem](download-item.md)
@@ -72,11 +72,11 @@ session.defaultSession.on('will-download', function(event, item, webContents) {
 });
 ```
 
-### Instance Methods
+## Instance Methods
 
 The following methods are available on instances of `Session`:
 
-#### `ses.cookies`
+### `session.cookies`
 
 The `cookies` gives you ability to query and modify cookies. For example:
 
@@ -100,7 +100,7 @@ session.defaultSession.cookies.set(cookie, function(error) {
 });
 ```
 
-#### `ses.cookies.get(filter, callback)`
+### `session.cookies.get(filter, callback)`
 
 * `filter` Object
   * `url` String (optional) - Retrieves cookies which are associated with
@@ -132,7 +132,7 @@ with `callback(error, cookies)` on complete.
      the number of seconds since the UNIX epoch. Not provided for session
      cookies.
 
-#### `ses.cookies.set(details, callback)`
+### `session.cookies.set(details, callback)`
 
 * `details` Object
   * `url` String - Retrieves cookies which are associated with `url`
@@ -151,7 +151,7 @@ with `callback(error, cookies)` on complete.
 Sets the cookie with `details`, `callback` will be called with `callback(error)`
 on complete.
 
-#### `ses.cookies.remove(url, name, callback)`
+### `session.cookies.remove(url, name, callback)`
 
 * `url` String - The URL associated with the cookie.
 * `name` String - The name of cookie to remove.
@@ -160,20 +160,20 @@ on complete.
 Removes the cookies matching `url` and `name`, `callback` will called with
 `callback()` on complete.
 
-#### `ses.getCacheSize(callback)`
+### `session.getCacheSize(callback)`
 
 * `callback` Function
   * `size` Integer - Cache size used in bytes.
 
 Returns the session's current cache size.
 
-#### `ses.clearCache(callback)`
+### `session.clearCache(callback)`
 
 * `callback` Function - Called when operation is done
 
 Clears the session’s HTTP cache.
 
-#### `ses.clearStorageData([options, ]callback)`
+### `session.clearStorageData([options, ]callback)`
 
 * `options` Object (optional)
   * `origin` String - Should follow `window.location.origin`’s representation
@@ -187,11 +187,11 @@ Clears the session’s HTTP cache.
 
 Clears the data of web storages.
 
-#### `ses.flushStorageData()`
+### `session.flushStorageData()`
 
 Writes any unwritten DOMStorage data to disk.
 
-#### `ses.setProxy(config, callback)`
+### `session.setProxy(config, callback)`
 
 * `config` Object
   * `pacScript` String - The URL associated with the PAC file.
@@ -228,7 +228,7 @@ For example:
 * `http=foopy;socks=foopy2` -  Use HTTP proxy `foopy` for http URLs, and use
   `socks4://foopy2` for all other URLs.
 
-### `ses.resolveProxy(url, callback)`
+### `session.resolveProxy(url, callback)`
 
 * `url` URL
 * `callback` Function
@@ -236,14 +236,14 @@ For example:
 Resolves the proxy information for `url`. The `callback` will be called with
 `callback(proxy)` when the request is performed.
 
-#### `ses.setDownloadPath(path)`
+### `session.setDownloadPath(path)`
 
 * `path` String - The download location
 
 Sets download saving directory. By default, the download directory will be the
 `Downloads` under the respective app folder.
 
-#### `ses.enableNetworkEmulation(options)`
+### `session.enableNetworkEmulation(options)`
 
 * `options` Object
   * `offline` Boolean - Whether to emulate network outage.
@@ -265,12 +265,12 @@ window.webContents.session.enableNetworkEmulation({
 window.webContents.session.enableNetworkEmulation({offline: true});
 ```
 
-#### `ses.disableNetworkEmulation()`
+### `session.disableNetworkEmulation()`
 
 Disables any network emulation already active for the `session`. Resets to
 the original network configuration.
 
-#### `ses.setCertificateVerifyProc(proc)`
+### `session.setCertificateVerifyProc(proc)`
 
 * `proc` Function
 
@@ -291,7 +291,7 @@ myWindow.webContents.session.setCertificateVerifyProc(function(hostname, cert, c
 });
 ```
 
-#### `ses.setPermissionRequestHandler(handler)`
+### `session.setPermissionRequestHandler(handler)`
 
 * `handler` Function
   * `webContents` Object - [WebContents](web-contents.md) requesting the permission.
@@ -314,13 +314,13 @@ session.fromPartition(partition).setPermissionRequestHandler(function(webContent
 });
 ```
 
-#### `ses.clearHostResolverCache([callback])`
+### `session.clearHostResolverCache([callback])`
 
 * `callback` Function (optional) - Called when operation is done.
 
 Clears the host resolver cache.
 
-#### `ses.webRequest`
+### `session.webRequest`
 
 The `webRequest` API set allows to intercept and modify contents of a request at
 various stages of its lifetime.
@@ -349,7 +349,7 @@ session.defaultSession.webRequest.onBeforeSendHeaders(filter, function(details,
 });
 ```
 
-#### `ses.webRequest.onBeforeRequest([filter, ]listener)`
+### `session.webRequest.onBeforeRequest([filter, ]listener)`
 
 * `filter` Object
 * `listener` Function
@@ -379,7 +379,7 @@ The `callback` has to be called with an `response` object:
   * `redirectURL` String (optional) - The original request is prevented from
     being sent or completed, and is instead redirected to the given URL.
 
-#### `ses.webRequest.onBeforeSendHeaders([filter, ]listener)`
+### `session.webRequest.onBeforeSendHeaders([filter, ]listener)`
 
 * `filter` Object
 * `listener` Function
@@ -404,7 +404,7 @@ The `callback` has to be called with an `response` object:
   * `requestHeaders` Object (optional) - When provided, request will be made
     with these headers.
 
-#### `ses.webRequest.onSendHeaders([filter, ]listener)`
+### `session.webRequest.onSendHeaders([filter, ]listener)`
 
 * `filter` Object
 * `listener` Function
@@ -421,7 +421,7 @@ response are visible by the time this listener is fired.
   * `timestamp` Double
   * `requestHeaders` Object
 
-#### `ses.webRequest.onHeadersReceived([filter,] listener)`
+### `session.webRequest.onHeadersReceived([filter,] listener)`
 
 * `filter` Object
 * `listener` Function
@@ -449,7 +449,7 @@ The `callback` has to be called with an `response` object:
   * `statusLine` String (optional) - Should be provided when overriding `responseHeaders`
     to change header status otherwise original response header's status will be used.
 
-#### `ses.webRequest.onResponseStarted([filter, ]listener)`
+### `session.webRequest.onResponseStarted([filter, ]listener)`
 
 * `filter` Object
 * `listener` Function
@@ -470,7 +470,7 @@ and response headers are available.
   * `statusCode` Integer
   * `statusLine` String
 
-#### `ses.webRequest.onBeforeRedirect([filter, ]listener)`
+### `session.webRequest.onBeforeRedirect([filter, ]listener)`
 
 * `filter` Object
 * `listener` Function
@@ -491,7 +491,7 @@ redirect is about to occur.
   * `fromCache` Boolean
   * `responseHeaders` Object
 
-#### `ses.webRequest.onCompleted([filter, ]listener)`
+### `session.webRequest.onCompleted([filter, ]listener)`
 
 * `filter` Object
 * `listener` Function
@@ -510,7 +510,7 @@ completed.
   * `statusCode` Integer
   * `statusLine` String
 
-#### `ses.webRequest.onErrorOccurred([filter, ]listener)`
+### `session.webRequest.onErrorOccurred([filter, ]listener)`
 
 * `filter` Object
 * `listener` Function