From 8695c93866fab77260b51487da389f9116f87065 Mon Sep 17 00:00:00 2001 From: Munieru <20086673+munierujp@users.noreply.github.com> Date: Mon, 14 Jun 2021 20:18:39 +0900 Subject: [PATCH] docs: Use Promises API of fs module in Puppeteer.md (#11541) --- docs/Puppeteer.md | 8 ++++---- website/versioned_docs/version-25.x/Puppeteer.md | 8 ++++---- website/versioned_docs/version-26.x/Puppeteer.md | 8 ++++---- website/versioned_docs/version-27.0/Puppeteer.md | 8 ++++---- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/Puppeteer.md b/docs/Puppeteer.md index 237d7dcce664..7e3d5743e7ed 100644 --- a/docs/Puppeteer.md +++ b/docs/Puppeteer.md @@ -55,7 +55,7 @@ Here's an example of the GlobalSetup script ```js // setup.js -const fs = require('fs'); +const { writeFile } = require('fs').promises; const os = require('os'); const path = require('path'); const mkdirp = require('mkdirp'); @@ -71,7 +71,7 @@ module.exports = async function () { // use the file system to expose the wsEndpoint for TestEnvironments mkdirp.sync(DIR); - fs.writeFileSync(path.join(DIR, 'wsEndpoint'), browser.wsEndpoint()); + await writeFile(path.join(DIR, 'wsEndpoint'), browser.wsEndpoint()); }; ``` @@ -79,7 +79,7 @@ Then we need a custom Test Environment for puppeteer ```js // puppeteer_environment.js -const fs = require('fs'); +const { readFile } = require('fs').promises; const os = require('os'); const path = require('path'); const puppeteer = require('puppeteer'); @@ -95,7 +95,7 @@ class PuppeteerEnvironment extends NodeEnvironment { async setup() { await super.setup(); // get the wsEndpoint - const wsEndpoint = fs.readFileSync(path.join(DIR, 'wsEndpoint'), 'utf8'); + const wsEndpoint = await readFile(path.join(DIR, 'wsEndpoint'), 'utf8'); if (!wsEndpoint) { throw new Error('wsEndpoint not found'); } diff --git a/website/versioned_docs/version-25.x/Puppeteer.md b/website/versioned_docs/version-25.x/Puppeteer.md index e071d8161fe3..fa9571644e83 100644 --- a/website/versioned_docs/version-25.x/Puppeteer.md +++ b/website/versioned_docs/version-25.x/Puppeteer.md @@ -55,7 +55,7 @@ Here's an example of the GlobalSetup script ```js // setup.js -const fs = require('fs'); +const { writeFile } = require('fs').promises; const os = require('os'); const path = require('path'); const mkdirp = require('mkdirp'); @@ -71,7 +71,7 @@ module.exports = async function () { // use the file system to expose the wsEndpoint for TestEnvironments mkdirp.sync(DIR); - fs.writeFileSync(path.join(DIR, 'wsEndpoint'), browser.wsEndpoint()); + await writeFile(path.join(DIR, 'wsEndpoint'), browser.wsEndpoint()); }; ``` @@ -79,7 +79,7 @@ Then we need a custom Test Environment for puppeteer ```js // puppeteer_environment.js -const fs = require('fs'); +const { readFile } = require('fs').promises; const os = require('os'); const path = require('path'); const puppeteer = require('puppeteer'); @@ -95,7 +95,7 @@ class PuppeteerEnvironment extends NodeEnvironment { async setup() { await super.setup(); // get the wsEndpoint - const wsEndpoint = fs.readFileSync(path.join(DIR, 'wsEndpoint'), 'utf8'); + const wsEndpoint = await readFile(path.join(DIR, 'wsEndpoint'), 'utf8'); if (!wsEndpoint) { throw new Error('wsEndpoint not found'); } diff --git a/website/versioned_docs/version-26.x/Puppeteer.md b/website/versioned_docs/version-26.x/Puppeteer.md index e071d8161fe3..fa9571644e83 100644 --- a/website/versioned_docs/version-26.x/Puppeteer.md +++ b/website/versioned_docs/version-26.x/Puppeteer.md @@ -55,7 +55,7 @@ Here's an example of the GlobalSetup script ```js // setup.js -const fs = require('fs'); +const { writeFile } = require('fs').promises; const os = require('os'); const path = require('path'); const mkdirp = require('mkdirp'); @@ -71,7 +71,7 @@ module.exports = async function () { // use the file system to expose the wsEndpoint for TestEnvironments mkdirp.sync(DIR); - fs.writeFileSync(path.join(DIR, 'wsEndpoint'), browser.wsEndpoint()); + await writeFile(path.join(DIR, 'wsEndpoint'), browser.wsEndpoint()); }; ``` @@ -79,7 +79,7 @@ Then we need a custom Test Environment for puppeteer ```js // puppeteer_environment.js -const fs = require('fs'); +const { readFile } = require('fs').promises; const os = require('os'); const path = require('path'); const puppeteer = require('puppeteer'); @@ -95,7 +95,7 @@ class PuppeteerEnvironment extends NodeEnvironment { async setup() { await super.setup(); // get the wsEndpoint - const wsEndpoint = fs.readFileSync(path.join(DIR, 'wsEndpoint'), 'utf8'); + const wsEndpoint = await readFile(path.join(DIR, 'wsEndpoint'), 'utf8'); if (!wsEndpoint) { throw new Error('wsEndpoint not found'); } diff --git a/website/versioned_docs/version-27.0/Puppeteer.md b/website/versioned_docs/version-27.0/Puppeteer.md index 237d7dcce664..7e3d5743e7ed 100644 --- a/website/versioned_docs/version-27.0/Puppeteer.md +++ b/website/versioned_docs/version-27.0/Puppeteer.md @@ -55,7 +55,7 @@ Here's an example of the GlobalSetup script ```js // setup.js -const fs = require('fs'); +const { writeFile } = require('fs').promises; const os = require('os'); const path = require('path'); const mkdirp = require('mkdirp'); @@ -71,7 +71,7 @@ module.exports = async function () { // use the file system to expose the wsEndpoint for TestEnvironments mkdirp.sync(DIR); - fs.writeFileSync(path.join(DIR, 'wsEndpoint'), browser.wsEndpoint()); + await writeFile(path.join(DIR, 'wsEndpoint'), browser.wsEndpoint()); }; ``` @@ -79,7 +79,7 @@ Then we need a custom Test Environment for puppeteer ```js // puppeteer_environment.js -const fs = require('fs'); +const { readFile } = require('fs').promises; const os = require('os'); const path = require('path'); const puppeteer = require('puppeteer'); @@ -95,7 +95,7 @@ class PuppeteerEnvironment extends NodeEnvironment { async setup() { await super.setup(); // get the wsEndpoint - const wsEndpoint = fs.readFileSync(path.join(DIR, 'wsEndpoint'), 'utf8'); + const wsEndpoint = await readFile(path.join(DIR, 'wsEndpoint'), 'utf8'); if (!wsEndpoint) { throw new Error('wsEndpoint not found'); }