# savePDF

Prints the page of the current browsing context to a PDF file on your OS.

## Usage[​](#usage "Direct link to Usage")

```
await browser.savePDF(filepath, { orientation, scale, background, width, height, top, bottom, left, right, shrinkToFit, pageRanges })
```

## Parameters[​](#parameters "Direct link to Parameters")

| Name                                  | Type                    | Details                                                                                   |
| ------------------------------------- | ----------------------- | ----------------------------------------------------------------------------------------- |
| `filepath`                            | `String`                | path to the generated pdf (`.pdf` suffix is required) relative to the execution directory |
| `options`<br />*optional*             | `PDFPrintOptions`       | Print PDF Options                                                                         |
| `options.orientation`<br />*optional* | `String`                | Orientation of PDF page                                                                   |
| `options.scale`<br />*optional*       | `number`                | Scale of PDF page                                                                         |
| `options.background`<br />*optional*  | `boolean`               | Include background of PDF page                                                            |
| `options.width`<br />*optional*       | `number`                | Width of PDF page                                                                         |
| `options.height`<br />*optional*      | `number`                | Height of PDF page                                                                        |
| `options.top`<br />*optional*         | `number`                | Top padding of PDF page                                                                   |
| `options.bottom`<br />*optional*      | `number`                | Bottom padding of PDF page                                                                |
| `options.left`<br />*optional*        | `number`                | Left padding of PDF page                                                                  |
| `options.right`<br />*optional*       | `number`                | Right padding of PDF page                                                                 |
| `options.shrinkToFit`<br />*optional* | `boolean`               | Shrink page to fit page                                                                   |
| `options.pageRanges`<br />*optional*  | `Array<string, number>` | Range of pages to include in PDF                                                          |

## Example[​](#example "Direct link to Example")

savePDF.js

```
it('should save a PDF screenshot of the browser view', function () {
    await browser.savePDF('./some/path/screenshot.pdf');
});
```

## Returns[​](#returns "Direct link to Returns")

* **\<Buffer>** **`return`:** screenshot buffer