eventType -> constructor

sainthkh · Aug 28, 2020 · e1455d8 · e1455d8
1 parent 8d1b5b5
commit e1455d8
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 14 deletions.
diff --git a/cli/types/cypress.d.ts b/cli/types/cypress.d.ts
@@ -2914,7 +2914,7 @@ declare namespace Cypress {
      *
      * @default 'Event'
      */
-    eventType: string
+    constructor: string
   }
 
   /** Options to change the default behavior of .writeFile */

diff --git a/packages/driver/cypress/integration/commands/actions/trigger_spec.js b/packages/driver/cypress/integration/commands/actions/trigger_spec.js
@@ -225,7 +225,7 @@ describe('src/cy/commands/actions/trigger', () => {
       })
 
       cy.get('input:first').trigger('mousedown', {
-        eventType: 'MouseEvent',
+        constructor: 'MouseEvent',
         button: 0,
         shiftKey: false,
         ctrlKey: false,
@@ -778,7 +778,7 @@ describe('src/cy/commands/actions/trigger', () => {
         })
 
         cy.get('input:first').trigger('keydown', {
-          eventType: 'KeyboardEvent',
+          constructor: 'KeyboardEvent',
           keyCode: 65,
           which: 65,
           shiftKey: false,
@@ -790,7 +790,7 @@ describe('src/cy/commands/actions/trigger', () => {
         cy.visit('fixtures/issue-5650.html')
 
         cy.get('#test-input').trigger('keydown', {
-          eventType: 'KeyboardEvent',
+          constructor: 'KeyboardEvent',
           keyCode: 65,
           which: 65,
           shiftKey: false,
@@ -813,7 +813,7 @@ describe('src/cy/commands/actions/trigger', () => {
         })
 
         cy.get('input:first').trigger('mousedown', {
-          eventType: 'MouseEvent',
+          constructor: 'MouseEvent',
           button: 0,
           shiftKey: false,
           ctrlKey: false,
@@ -823,7 +823,7 @@ describe('src/cy/commands/actions/trigger', () => {
       it('should trigger MouseEvent with .trigger inside html script event listener', () => {
         cy.visit('fixtures/issue-5650.html')
         cy.get('#test-input').trigger('mousedown', {
-          eventType: 'MouseEvent',
+          constructor: 'MouseEvent',
           button: 0,
           shiftKey: false,
           ctrlKey: false,
@@ -958,13 +958,13 @@ describe('src/cy/commands/actions/trigger', () => {
       it('throws when provided invalid event type', function (done) {
         cy.on('fail', (err) => {
           expect(this.logs.length).to.eq(2)
-          expect(err.message).to.eq('Timed out retrying: `cy.trigger()` `eventType` option must be a valid event (e.g. \'MouseEvent\', \'KeyboardEvent\'). You passed: `FooEvent`')
+          expect(err.message).to.eq('Timed out retrying: `cy.trigger()` `constructor` option must be a valid event (e.g. \'MouseEvent\', \'KeyboardEvent\'). You passed: `FooEvent`')
 
           done()
         })
 
         cy.get('button:first').trigger('mouseover', {
-          eventType: 'FooEvent',
+          constructor: 'FooEvent',
         })
       })
 

diff --git a/packages/driver/src/cy/commands/actions/trigger.js b/packages/driver/src/cy/commands/actions/trigger.js
@@ -6,17 +6,17 @@ const $errUtils = require('../../../cypress/error_utils')
 const $actionability = require('../../actionability')
 
 const dispatch = (target, appWindow, eventName, options) => {
-  const eventType = options.eventType ?? 'Event'
-  const ctor = appWindow[eventType]
+  const constructor = options.constructor ?? 'Event'
+  const ctor = appWindow[constructor]
 
   if (typeof ctor !== 'function') {
     $errUtils.throwErrByPath('trigger.invalid_event_type', {
-      args: { eventType },
+      args: { constructor },
     })
   }
 
-  // eventType property should not be added to event instance.
-  delete options.eventType
+  // constructor property should not be added to event instance.
+  delete options.constructor
 
   // https://github.com/cypress-io/cypress/issues/3686
   // UIEvent and its derived events like MouseEvent, KeyboardEvent

diff --git a/packages/driver/src/cypress/error_messages.js b/packages/driver/src/cypress/error_messages.js
@@ -1510,7 +1510,7 @@ module.exports = {
       docsUrl: 'https://on.cypress.io/trigger',
     },
     invalid_event_type: {
-      message: `${cmd('trigger')} \`eventType\` option must be a valid event (e.g. 'MouseEvent', 'KeyboardEvent'). You passed: \`{{eventType}}\``,
+      message: `${cmd('trigger')} \`constructor\` option must be a valid event (e.g. 'MouseEvent', 'KeyboardEvent'). You passed: \`{{constructor}}\``,
       docsUrl: 'https://on.cypress.io/trigger',
     },
   },