refactor: add some types

Author: root

src/create-dom-event.ts

@@ -1,5 +1,19 @@
 import eventTypes from 'dom-event-types'
 
+interface TriggerOptions {
+  code?: String
+  key?: String
+  keyCode?: Number
+  [custom: string]: any
+}
+
+interface EventParams {
+  eventType: string
+  modifier: string
+  meta: any
+  options?: TriggerOptions
+}
+
 const keyCodesByKeyName = {
   backspace: 8,
   tab: 9,
@@ -18,9 +32,11 @@ const keyCodesByKeyName = {
   delete: 46
 }
 
-function getEventProperties(eventParams) {
+function getEventProperties(eventParams: EventParams) {
   const { modifier, meta, options } = eventParams
-  const keyCode = keyCodesByKeyName[modifier] || options.keyCode || options.code
+  const keyCode =
+    keyCodesByKeyName[modifier] ||
+    (options && (options.keyCode || options.code))
 
   return {
     ...options, // What the user passed in as the second argument to #trigger
@@ -32,7 +48,7 @@ function getEventProperties(eventParams) {
   }
 }
 
-function createEvent(eventParams) {
+function createEvent(eventParams: EventParams) {
   const { eventType, meta } = eventParams
   const metaEventInterface = window[meta.eventInterface]
 
@@ -51,37 +67,32 @@ function createEvent(eventParams) {
   return event
 }
 
-export default function createDOMEvent(
-  eventString: String,
-  options: Object = {}
-) {
+function createDOMEvent(eventString: String, options?: TriggerOptions) {
   const [eventType, modifier] = eventString.split('.')
   const meta = eventTypes[eventType] || {
     eventInterface: 'Event',
     cancelable: true,
     bubbles: true
   }
 
-  const eventParams = { eventType, modifier, meta, options }
-
-  const event = createEvent(eventParams)
-
+  const eventParams: EventParams = { eventType, modifier, meta, options }
+  const event: Event = createEvent(eventParams)
   const eventPrototype = Object.getPrototypeOf(event)
 
-  Object.keys(options).forEach((key) => {
-    const propertyDescriptor = Object.getOwnPropertyDescriptor(
-      eventPrototype,
-      key
-    )
-
-    const canSetProperty = !(
-      propertyDescriptor && propertyDescriptor.set === undefined
-    )
-
-    if (canSetProperty) {
-      event[key] = options[key]
-    }
-  })
-
+  options &&
+    Object.keys(options).forEach((key) => {
+      const propertyDescriptor = Object.getOwnPropertyDescriptor(
+        eventPrototype,
+        key
+      )
+      const canSetProperty = !(
+        propertyDescriptor && propertyDescriptor.set === undefined
+      )
+      if (canSetProperty) {
+        event[key] = options[key]
+      }
+    })
   return event
 }
+
+export { TriggerOptions, createDOMEvent }

src/dom-wrapper.ts

@@ -3,7 +3,7 @@ import { nextTick } from 'vue'
 import { WrapperAPI } from './types'
 import { ErrorWrapper } from './error-wrapper'
 
-import createDOMEvent from './create-dom-event'
+import { TriggerOptions, createDOMEvent } from './create-dom-event'
 
 export class DOMWrapper<ElementType extends Element> implements WrapperAPI {
   element: ElementType
@@ -136,8 +136,8 @@ export class DOMWrapper<ElementType extends Element> implements WrapperAPI {
     return new DOMWrapper(parentElement).trigger('change')
   }
 
-  async trigger(eventString: string, options: Object = {}) {
-    if (options['target']) {
+  async trigger(eventString: string, options?: TriggerOptions) {
+    if (options && options['target']) {
       throw Error(
         `[vue-test-utils]: you cannot set the target value of an event. See the notes section ` +
           `of the docs for more details—` +

src/vue-wrapper.ts

@@ -5,6 +5,7 @@ import { DOMWrapper } from './dom-wrapper'
 import { WrapperAPI } from './types'
 import { ErrorWrapper } from './error-wrapper'
 import { MOUNT_ELEMENT_ID } from './constants'
+import { TriggerOptions } from './create-dom-event'
 
 export class VueWrapper<T extends ComponentPublicInstance>
   implements WrapperAPI {
@@ -105,7 +106,7 @@ export class VueWrapper<T extends ComponentPublicInstance>
     return nextTick()
   }
 
-  trigger(eventString: string, options: Object = {}) {
+  trigger(eventString: string, options?: TriggerOptions) {
     const rootElementWrapper = new DOMWrapper(this.element)
     return rootElementWrapper.trigger(eventString, options)
   }