[#31] type updates to allow optional config (#32)

* fix: type updates to allow optional config * chore: disable chrome web security while testing on 3rd party sites
cmorten · Dec 14, 2023 · 07afc6f · 07afc6f
1 parent 4eaa29c
commit 07afc6f
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 7 deletions.
diff --git a/commands.d.ts b/commands.d.ts
@@ -139,26 +139,26 @@ declare namespace Cypress {
      * Runs a Web Vitals audit
      * @example
      * cy.vitals({ thresholds, url, selector });
-     * @param {WebVitalsConfig} webVitalsConfig configuration
+     * @param {WebVitalsConfig} [webVitalsConfig] configuration
      */
     vitals(webVitalsConfig?: WebVitalsConfig);
 
     /**
      * Starts a Web Vitals audit. Use with `cy.reportVitals()`.
      * @example
      * cy.startVitalsCapture({ url });
-     * @param {StartWebVitalsCaptureConfig} startWebVitalsCaptureConfig configuration
+     * @param {StartWebVitalsCaptureConfig} [startWebVitalsCaptureConfig] configuration
      */
     startVitalsCapture(
-      startWebVitalsCaptureConfig: StartWebVitalsCaptureConfig
+      startWebVitalsCaptureConfig?: StartWebVitalsCaptureConfig
     );
 
     /**
      * Reports on a Web Vitals audit. Use with `cy.startVitalsCapture()`.
      * @example
      * cy.reportVitals({ thresholds });
-     * @param {ReportWebVitalsConfig} reportWebVitalsConfig configuration
+     * @param {ReportWebVitalsConfig} [reportWebVitalsConfig] configuration
      */
-    reportVitals(reportWebVitalsConfig: ReportWebVitalsConfig);
+    reportVitals(reportWebVitalsConfig?: ReportWebVitalsConfig);
   }
 }
diff --git a/examples/10.x/cypress.config.js b/examples/10.x/cypress.config.js
@@ -3,6 +3,7 @@ const { defineConfig } = require("cypress");
 module.exports = defineConfig({
   video: false,
   screenshotOnRunFailure: false,
+  chromeWebSecurity: false,
   e2e: {
     setupNodeEvents(_on, _config) {},
   },

diff --git a/examples/12.x/cypress.config.js b/examples/12.x/cypress.config.js
@@ -3,6 +3,7 @@ const { defineConfig } = require("cypress");
 module.exports = defineConfig({
   video: false,
   screenshotOnRunFailure: false,
+  chromeWebSecurity: false,
   e2e: {
     setupNodeEvents(_on, _config) {},
   },

diff --git a/examples/13.x/cypress.config.js b/examples/13.x/cypress.config.js
@@ -1,7 +1,9 @@
 const { defineConfig } = require("cypress");
 
 module.exports = defineConfig({
+  video: false,
   screenshotOnRunFailure: false,
+  chromeWebSecurity: false,
   e2e: {
     setupNodeEvents(_on, _config) {},
   },

diff --git a/examples/9.x/cypress.json b/examples/9.x/cypress.json
@@ -1,4 +1,5 @@
 {
   "video": false,
-  "screenshotOnRunFailure": false
+  "screenshotOnRunFailure": false,
+  "chromeWebSecurity": false
 }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "cypress-web-vitals",
-  "version": "4.1.0",
+  "version": "4.1.1",
   "description": "A Web Vitals command for cypress",
   "author": "Craig Morten <[email protected]>",
   "license": "MIT",