docs: options of session.fromPartition
authorCheng Zhao <zcbenz@gmail.com>
Tue, 12 Jul 2016 13:21:49 +0000 (22:21 +0900)
committerCheng Zhao <zcbenz@gmail.com>
Wed, 13 Jul 2016 03:23:14 +0000 (12:23 +0900)
docs/api/session.md

index 78b001f..91ff30a 100644 (file)
@@ -20,17 +20,25 @@ const ses = win.webContents.session
 
 The `session` module has the following methods:
 
-### session.fromPartition(partition)
+### session.fromPartition(partition[, options])
 
 * `partition` String
+* `options` Object
+  * `cache` Boolean - Whether to enable cache.
 
-Returns a new `Session` instance from `partition` string.
+Returns a `Session` instance from `partition` string. When there is an existing
+`Session` with the same `partition`, it will be returned; othewise a new
+`Session` instance will be created with `options`.
 
 If `partition` starts with `persist:`, the page will use a persistent session
 available to all pages in the app with the same `partition`. if there is no
 `persist:` prefix, the page will use an in-memory session. If the `partition` is
 empty then default session of the app will be returned.
 
+To create a `Session` with `options`, you have to ensure the `Session` with the
+`partition` has never been used before. There is no way to change the `options`
+of an existing `Session` object.
+
 ## Properties
 
 The `session` module has the following properties: