We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 59b89f7 commit 67246eeCopy full SHA for 67246ee
cli/lib/cypress.js
@@ -70,9 +70,13 @@ const cypressModuleApi = {
70
},
71
72
/**
73
- * This function should not be used in pure JavaScript
74
- * By the type of its argument it allows autocompletion and
75
- * type checking of the configuration given by users.
+ * provides automatic code completion for configuration in many popular code editors.
+ * While it's not strictly necessary for Cypress to parse your configuration, we
+ * recommend wrapping your config object with `defineConfig()`
76
+ * @example
77
+ * module.exports = defineConfig({
78
+ * viewportWith: 400
79
+ * })
80
*
81
* @see ../types/cypress-npm-api.d.ts
82
* @param {Cypress.ConfigOptions} config
0 commit comments