Merge pull request #43 from WebPageTest/mobileDevice

Recipe for emulating a mobile device

Author: Siddhantshukla814

README.md

@@ -12,6 +12,7 @@ WebPageTest API Recipes
 - [Emulate a slow network](#emulate-a-slow-network)
 - [Emulate a slow network and CPU throttling](#emulate-network-&-cputhrottle)
 - [Emulate a custom connectivity (Bandwidth, Latency, PacketLossRate)](#emulate-a-custom-connectivity)
+- [Emulate a test on mobile device](#Emulate-a-test-on-mobile-device)
 - [Retrieve your Core Web Vitals](#retrieve-your-core-web-vitals)
 - [Retrieve your Core Web Vitals + CrUX data for the tested URL](#retrieve-your-core-web-vitals-+-crux)
 - [Run a test with a third-party domain blocked](#run-a-test-with-a-third-party-domain-blocked)
@@ -116,6 +117,38 @@ wpt.runTest(testURL, options, (err, result) => {
 
 [Source](connectivity-custom.js)
 
+<h3 id="Emulate-a-test-on-mobile-device">Emulate a test on mobile device</h3>
+
+```js
+import WebPageTest from "webpagetest";
+
+const wpt = new WebPageTest("https://www.webpagetest.org", "YOUR_API_KEY");
+
+let testURL = "https://docs.webpagetest.org/"; //Your URL here
+
+let options = {
+  location: "ec2-us-east-1:Chrome",
+  label: "emulate mobile device",
+  firstViewOnly: true,
+  emulateMobile: true,
+  device: "Nexus5", // optional (default: MotoG4)
+};
+
+//Supported devices: https://github.com/WPO-Foundation/webpagetest/blob/master/www/settings/mobile_devices.ini
+
+// Run the test
+wpt.runTest(testURL, options, (err, result) => {
+  if (result) {
+    console.log(result);
+  } else {
+    console.log(err);
+  }
+});
+
+```
+
+[Source](mobile-device.js)
+
 <h3 id="retrieve-your-core-web-vitals">Retrieve your Core Web Vitals</h3>
 
 ```js

mobile-device.js

@@ -0,0 +1,24 @@
+import WebPageTest from "webpagetest";
+
+const wpt = new WebPageTest("https://www.webpagetest.org", "YOUR_API_KEY");
+
+let testURL = "https://docs.webpagetest.org/"; //Your URL here
+
+let options = {
+  location: "ec2-us-east-1:Chrome",
+  label: "emulate mobile device",
+  firstViewOnly: true,
+  emulateMobile: true,
+  device: "Nexus5", // optional (default: MotoG4)
+};
+
+//List of support devices https://github.com/WPO-Foundation/webpagetest/blob/master/www/settings/mobile_devices.ini
+
+// Run the test
+wpt.runTest(testURL, options, (err, result) => {
+  if (result) {
+    console.log(result);
+  } else {
+    console.log(err);
+  }
+});