From aa58f25bc1c7f8cf72c70c453f036bb873349164 Mon Sep 17 00:00:00 2001 From: cohesively Date: Sat, 16 Sep 2017 00:27:14 -0400 Subject: [PATCH] doc: add await to browser.close in usage examples (#797) browser.close returns a promise after f398e69, so it should be awaited. --- README.md | 6 +++--- docs/api.md | 26 +++++++++++++------------- examples/block-images.js | 2 +- examples/custom-event.js | 2 +- examples/detect-sniff.js | 2 +- examples/pdf.js | 2 +- examples/proxy.js | 2 +- examples/screenshot-fullpage.js | 2 +- examples/screenshot.js | 2 +- examples/search.js | 2 +- 10 files changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index a2aee84f..8eec16f4 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ const puppeteer = require('puppeteer'); await page.goto('https://example.com'); await page.screenshot({path: 'example.png'}); - browser.close(); + await browser.close(); })(); ``` @@ -64,7 +64,7 @@ const puppeteer = require('puppeteer'); await page.goto('https://news.ycombinator.com', {waitUntil: 'networkidle'}); await page.pdf({path: 'hn.pdf', format: 'A4'}); - browser.close(); + await browser.close(); })(); ``` @@ -91,7 +91,7 @@ const puppeteer = require('puppeteer'); console.log('Dimensions:', dimensions); - browser.close(); + await browser.close(); })(); ``` diff --git a/docs/api.md b/docs/api.md index 10f33fb7..1672bb92 100644 --- a/docs/api.md +++ b/docs/api.md @@ -162,7 +162,7 @@ puppeteer.launch().then(async browser => { const page = await browser.newPage(); await page.goto('https://www.google.com'); // other actions... - browser.close(); + await browser.close(); }); ``` @@ -205,7 +205,7 @@ const puppeteer = require('puppeteer'); puppeteer.launch().then(async browser => { const page = await browser.newPage(); await page.goto('https://example.com'); - browser.close(); + await browser.close(); }); ``` @@ -240,7 +240,7 @@ puppeteer.launch().then(async browser => { const page = await browser.newPage(); await page.goto('https://example.com'); await page.screenshot({path: 'screenshot.png'}); - browser.close(); + await browser.close(); }); ``` @@ -441,7 +441,7 @@ puppeteer.launch().then(async browser => { await page.emulate(iPhone); await page.goto('https://www.google.com'); // other actions... - browser.close(); + await browser.close(); }); ``` @@ -520,7 +520,7 @@ puppeteer.launch().then(async browser => { const myHash = await window.md5(myString); console.log(`md5 of ${myString} is ${myHash}`); }); - browser.close(); + await browser.close(); }); ``` @@ -548,7 +548,7 @@ puppeteer.launch().then(async browser => { const content = await window.readfile('/etc/hosts'); console.log(content); }); - browser.close(); + await browser.close(); }); ``` @@ -775,7 +775,7 @@ puppeteer.launch().then(async browser => { interceptedRequest.continue(); }); await page.goto('https://example.com'); - browser.close(); + await browser.close(); }); ``` @@ -877,7 +877,7 @@ puppeteer.launch().then(async browser => { const watchDog = page.waitForFunction('window.innerWidth < 100'); page.setViewport({width: 50, height: 50}); await watchDog; - browser.close(); + await browser.close(); }); ``` Shortcut for [page.mainFrame().waitForFunction(pageFunction[, options[, ...args]])](#framewaitforfunctionpagefunction-options-args). @@ -915,7 +915,7 @@ puppeteer.launch().then(async browser => { .then(() => console.log('First URL with image: ' + currentURL)); for (currentURL of ['https://example.com', 'https://google.com', 'https://bbc.com']) await page.goto(currentURL); - browser.close(); + await browser.close(); }); ``` Shortcut for [page.mainFrame().waitForSelector(selector[, options])](#framewaitforselectorselector-options). @@ -1051,7 +1051,7 @@ puppeteer.launch().then(async browser => { page.on('dialog', async dialog => { console.log(dialog.message()); await dialog.dismiss(); - browser.close(); + await browser.close(); }); page.evaluate(() => alert('1')); }); @@ -1093,7 +1093,7 @@ puppeteer.launch().then(async browser => { const page = await browser.newPage(); await page.goto('https://www.google.com/chrome/browser/canary.html'); dumpFrameTree(page.mainFrame(), ''); - browser.close(); + await browser.close(); function dumpFrameTree(frame, indent) { console.log(indent + frame.url()); @@ -1229,7 +1229,7 @@ puppeteer.launch().then(async browser => { const watchDog = page.mainFrame().waitForFunction('window.innerWidth < 100'); page.setViewport({width: 50, height: 50}); await watchDog; - browser.close(); + await browser.close(); }); ``` @@ -1256,7 +1256,7 @@ puppeteer.launch().then(async browser => { .then(() => console.log('First URL with image: ' + currentURL)); for (currentURL of ['https://example.com', 'https://google.com', 'https://bbc.com']) await page.goto(currentURL); - browser.close(); + await browser.close(); }); ``` diff --git a/examples/block-images.js b/examples/block-images.js index 89a79cf6..3bab12c1 100644 --- a/examples/block-images.js +++ b/examples/block-images.js @@ -32,7 +32,7 @@ page.on('request', request => { await page.goto('https://www.reuters.com/'); await page.screenshot({path: 'news.png', fullPage: true}); -browser.close(); +await browser.close(); })(); diff --git a/examples/custom-event.js b/examples/custom-event.js index 14a77fcd..6b958b37 100644 --- a/examples/custom-event.js +++ b/examples/custom-event.js @@ -45,6 +45,6 @@ await listenFor('app-ready'); // Listen for "app-ready" custom event on page loa await page.goto('https://www.chromestatus.com/features', {waitUntil: 'networkidle'}); -browser.close(); +await browser.close(); })(); diff --git a/examples/detect-sniff.js b/examples/detect-sniff.js index 574cee9d..f55fb88c 100644 --- a/examples/detect-sniff.js +++ b/examples/detect-sniff.js @@ -41,6 +41,6 @@ await page.evaluateOnNewDocument(sniffDetector); await page.goto('https://www.google.com', {waitUntil: 'networkidle'}); console.log('Sniffed: ' + (await page.evaluate(() => !!navigator.sniffed))); -browser.close(); +await browser.close(); })(); diff --git a/examples/pdf.js b/examples/pdf.js index dd5b8417..836d0b13 100644 --- a/examples/pdf.js +++ b/examples/pdf.js @@ -30,6 +30,6 @@ await page.pdf({ format: 'letter' }); -browser.close(); +await browser.close(); })(); diff --git a/examples/proxy.js b/examples/proxy.js index e28d2629..f7d6e61f 100644 --- a/examples/proxy.js +++ b/examples/proxy.js @@ -28,6 +28,6 @@ const browser = await puppeteer.launch({ }); const page = await browser.newPage(); await page.goto('https://google.com'); -browser.close(); +await browser.close(); })(); diff --git a/examples/screenshot-fullpage.js b/examples/screenshot-fullpage.js index b5644f64..6d39fac1 100644 --- a/examples/screenshot-fullpage.js +++ b/examples/screenshot-fullpage.js @@ -26,6 +26,6 @@ const page = await browser.newPage(); await page.emulate(devices['iPhone 6']); await page.goto('https://www.nytimes.com/'); await page.screenshot({path: 'full.png', fullPage: true}); -browser.close(); +await browser.close(); })(); diff --git a/examples/screenshot.js b/examples/screenshot.js index a78b038d..d8271bab 100644 --- a/examples/screenshot.js +++ b/examples/screenshot.js @@ -25,6 +25,6 @@ const page = await browser.newPage(); await page.goto('http://example.com'); await page.screenshot({path: 'example.png'}); -browser.close(); +await browser.close(); })(); diff --git a/examples/search.js b/examples/search.js index 5c094e34..cd13f8ab 100644 --- a/examples/search.js +++ b/examples/search.js @@ -37,6 +37,6 @@ const links = await page.evaluate(() => { return anchors.map(anchor => anchor.textContent); }); console.log(links.join('\n')); -browser.close(); +await browser.close(); })();