Fix doc on pdf method. Minor addition to PDF path option docs. (puppe…

…teer#292)
justjake · Aug 16, 2017 · da53218 · da53218
1 parent 92e64e2
commit da53218
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 3 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -529,7 +529,7 @@ Page is guaranteed to have a main frame which persists during navigations.
 
 #### page.pdf(options)
 - `options` <[Object]> Options object which might have the following properties:
-  - `path` <[string]> The file path to save the PDF to. If `path` is a relative path, then it is resolved relative to [current working directory](https://nodejs.org/api/process.html#process_process_cwd).
+  - `path` <[string]> The file path to save the PDF to. If `path` is a relative path, then it is resolved relative to [current working directory](https://nodejs.org/api/process.html#process_process_cwd). If no path is provided, the PDF won't be saved to the disk.
   - `scale` <[number]> Scale of the webpage rendering. Defaults to `1`.
   - `displayHeaderFooter` <[boolean]> Display header and footer. Defaults to `false`.
   - `printBackground` <[boolean]> Print background graphics. Defaults to `false`.
@@ -596,7 +596,7 @@ Shortcut for [`keyboard.down`](#keyboarddownkey-options) and [`keyboard.up`](#ke
 
 #### page.screenshot([options])
 - `options` <[Object]> Options object which might have the following properties:
-    - `path` <[string]> The file path to save the image to. The screenshot type will be inferred from file extension. If `path` is a relative path, then it is resolved relative to [current working directory](https://nodejs.org/api/process.html#process_process_cwd).
+    - `path` <[string]> The file path to save the image to. The screenshot type will be inferred from file extension. If `path` is a relative path, then it is resolved relative to [current working directory](https://nodejs.org/api/process.html#process_process_cwd). If no path is provided, the image won't be saved to the disk.
     - `type` <[string]> Specify screenshot type, could be either `jpeg` or `png`. Defaults to 'png'.
     - `quality` <[number]> The quality of the image, between 0-100. Not applicable to `png` images.
     - `fullPage` <[boolean]> When true, takes a screenshot of the full scrollable page. Defaults to `false`.

diff --git a/lib/Page.js b/lib/Page.js
@@ -479,7 +479,6 @@ class Page extends EventEmitter {
   }
 
   /**
-   * @param {string} filePath
    * @param {!Object=} options
    * @return {!Promise<!Buffer>}
    */
-Original file line number
+Diff line change
@@ Expand Up / @@ -479,7 +479,6 @@ class Page extends EventEmitter { @@
       }
       /**
-       * @param {string} filePath
        * @param {!Object=} options
        * @return {!Promise<!Buffer>}
        */
@@ Expand Down @@