puppeteer
Advanced tools
Comparing version 1.0.0-next.1515641713768 to 1.0.0-next.1515659454855
{ | ||
"name": "puppeteer", | ||
"version": "1.0.0-next.1515641713768", | ||
"version": "1.0.0-next.1515659454855", | ||
"description": "A high-level API to control headless Chrome over the DevTools Protocol", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
@@ -1,3 +0,7 @@ | ||
# Puppeteer [![Linux Build Status](https://img.shields.io/travis/GoogleChrome/puppeteer/master.svg)](https://travis-ci.org/GoogleChrome/puppeteer) [![Windows Build Status](https://img.shields.io/appveyor/ci/aslushnikov/puppeteer/master.svg?logo=appveyor)](https://ci.appveyor.com/project/aslushnikov/puppeteer/branch/master) [![NPM puppeteer package](https://img.shields.io/npm/v/puppeteer.svg)](https://npmjs.org/package/puppeteer) | ||
# Puppeteer | ||
<!-- [START badges] --> | ||
[![Linux Build Status](https://img.shields.io/travis/GoogleChrome/puppeteer/master.svg)](https://travis-ci.org/GoogleChrome/puppeteer) [![Windows Build Status](https://img.shields.io/appveyor/ci/aslushnikov/puppeteer/master.svg?logo=appveyor)](https://ci.appveyor.com/project/aslushnikov/puppeteer/branch/master) [![NPM puppeteer package](https://img.shields.io/npm/v/puppeteer.svg)](https://npmjs.org/package/puppeteer) | ||
<!-- [END badges] --> | ||
<img src="https://user-images.githubusercontent.com/10379601/29446482-04f7036a-841f-11e7-9872-91d1fc2ea683.png" height="200" align="right"> | ||
@@ -9,2 +13,3 @@ | ||
<!-- [START usecases] --> | ||
###### What can I do? | ||
@@ -20,5 +25,7 @@ | ||
* Capture a [timeline trace](https://developers.google.com/web/tools/chrome-devtools/evaluate-performance/reference) of your site to help diagnose performance issues. | ||
<!-- [END usecases] --> | ||
Give it a spin: https://try-puppeteer.appspot.com/ | ||
<!-- [START getstarted] --> | ||
## Getting Started | ||
@@ -28,4 +35,2 @@ | ||
> *Note: Puppeteer requires at least Node v6.4.0, but the examples below use async/await which is only supported in Node v7.6.0 or greater* | ||
To use Puppeteer in your project, run: | ||
@@ -37,6 +42,8 @@ ``` | ||
> **Note**: When you install Puppeteer, it downloads a recent version of Chromium (~71Mb Mac, ~90Mb Linux, ~110Mb Win) that is guaranteed to work with the API. To skip the download, see [Environment variables](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#environment-variables). | ||
Note: When you install Puppeteer, it downloads a recent version of Chromium (~71Mb Mac, ~90Mb Linux, ~110Mb Win) that is guaranteed to work with the API. To skip the download, see [Environment variables](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#environment-variables). | ||
### Usage | ||
Caution: Puppeteer requires at least Node v6.4.0, but the examples below use async/await which is only supported in Node v7.6.0 or greater. | ||
Puppeteer will be familiar to people using other browser testing frameworks. You create an instance | ||
@@ -106,2 +113,5 @@ of `Browser`, open pages, and then manipulate them with [Puppeteer's API](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#). | ||
<!-- [END getstarted] --> | ||
<!-- [START runtimesettings] --> | ||
## Default runtime settings | ||
@@ -136,2 +146,4 @@ | ||
<!-- [END runtimesettings] --> | ||
## API Documentation | ||
@@ -141,2 +153,4 @@ | ||
<!-- [START debugging] --> | ||
## Debugging tips | ||
@@ -148,5 +162,3 @@ | ||
```js | ||
const browser = await puppeteer.launch({headless: false}); | ||
``` | ||
const browser = await puppeteer.launch({headless: false}); | ||
@@ -156,8 +168,6 @@ 1. Slow it down - the `slowMo` option slows down Puppeteer operations by the | ||
```js | ||
const browser = await puppeteer.launch({ | ||
headless: false, | ||
slowMo: 250 // slow down by 250ms | ||
}); | ||
``` | ||
const browser = await puppeteer.launch({ | ||
headless: false, | ||
slowMo: 250 // slow down by 250ms | ||
}); | ||
@@ -167,28 +177,23 @@ 1. Capture console output - You can listen for the `console` event. | ||
```js | ||
page.on('console', msg => console.log('PAGE LOG:', ...msg.args)); | ||
page.on('console', msg => console.log('PAGE LOG:', ...msg.args)); | ||
await page.evaluate(() => console.log(`url is ${location.href}`)); | ||
await page.evaluate(() => console.log(`url is ${location.href}`)); | ||
``` | ||
1. Enable verbose logging - All public API calls and internal protocol traffic | ||
will be logged via the [`debug`](https://github.com/visionmedia/debug) module under the `puppeteer` namespace. | ||
```sh | ||
# Basic verbose logging | ||
env DEBUG="puppeteer:*" node script.js | ||
# Basic verbose logging | ||
env DEBUG="puppeteer:*" node script.js | ||
# Debug output can be enabled/disabled by namespace | ||
env DEBUG="puppeteer:*,-puppeteer:protocol" node script.js # everything BUT protocol messages | ||
env DEBUG="puppeteer:session" node script.js # protocol session messages (protocol messages to targets) | ||
env DEBUG="puppeteer:mouse,puppeteer:keyboard" node script.js # only Mouse and Keyboard API calls | ||
# Debug output can be enabled/disabled by namespace | ||
env DEBUG="puppeteer:*,-puppeteer:protocol" node script.js # everything BUT protocol messages | ||
env DEBUG="puppeteer:session" node script.js # protocol session messages (protocol messages to targets) | ||
env DEBUG="puppeteer:mouse,puppeteer:keyboard" node script.js # only Mouse and Keyboard API calls | ||
# Protocol traffic can be rather noisy. This example filters out all Network domain messages | ||
env DEBUG="puppeteer:*" env DEBUG_COLORS=true node script.js 2>&1 | grep -v '"Network' | ||
``` | ||
# Protocol traffic can be rather noisy. This example filters out all Network domain messages | ||
env DEBUG="puppeteer:*" env DEBUG_COLORS=true node script.js 2>&1 | grep -v '"Network' | ||
<!-- [END debugging] --> | ||
## Contributing to Puppeteer | ||
@@ -198,2 +203,4 @@ | ||
<!-- [START faq] --> | ||
# FAQ | ||
@@ -243,1 +250,3 @@ | ||
* Since Puppeteer (in all configurations) controls a desktop version of Chromium/Chrome, features that are only supported by the mobile version of Chrome are not supported. This means that Puppeteer [does not support HTTP Live Streaming (HLS)](https://caniuse.com/#feat=http-live-streaming). | ||
<!-- [END faq] --> |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
254580
241