feat(core): triggerEventHandler accept optional eventObj (angular#45279)

JiaLiPassion · atscott · commit 225e4f2dbeac · 2022-03-09T13:51:54.000-08:00
Close angular#44724 `DebugNode.triggerEventHandler()` should accept the `eventObj` as an optional parameter. So the user don't have to write code like ``` elem.triggerEventHandler('click', null); ``` PR Close angular#45279
diff --git a/goldens/public-api/core/core.md b/goldens/public-api/core/core.md
@@ -320,7 +320,7 @@ export class DebugElement extends DebugNode {
     get styles(): {
         [key: string]: string | null;
     };
-    triggerEventHandler(eventName: string, eventObj: any): void;
+    triggerEventHandler(eventName: string, eventObj?: any): void;
 }
 
 // @public (undocumented)
diff --git a/packages/core/src/debug/debug_node.ts b/packages/core/src/debug/debug_node.ts
@@ -343,7 +343,7 @@ export class DebugElement extends DebugNode {
    *
    * @see [Testing components scenarios](guide/testing-components-scenarios#trigger-event-handler)
    */
-  triggerEventHandler(eventName: string, eventObj: any): void {
+  triggerEventHandler(eventName: string, eventObj?: any): void {
     const node = this.nativeNode as any;
     const invokedListeners: Function[] = [];
 
diff --git a/packages/core/test/debug/debug_node_spec.ts b/packages/core/test/debug/debug_node_spec.ts
@@ -978,11 +978,11 @@ class TestCmptWithPropInterpolation {
       const button = fixture.debugElement.query(By.css('button'));
 
       expect(() => {
-        button.triggerEventHandler('click', null);
+        button.triggerEventHandler('click');
         fixture.detectChanges();
       }).not.toThrow();
 
-      expect(value).toBeNull();
+      expect(value).toBeUndefined();
     });
 
     describe('componentInstance on DebugNode', () => {
diff --git a/packages/forms/test/reactive_integration_spec.ts b/packages/forms/test/reactive_integration_spec.ts
@@ -3458,7 +3458,7 @@ const ValueAccessorB = createControlValueAccessor('[cva-b]');
         const inputNativeEl = inputEl.nativeElement;
         expect(inputNativeEl.value).toEqual('oldValue');
 
-        inputEl.triggerEventHandler('compositionstart', null);
+        inputEl.triggerEventHandler('compositionstart');
 
         inputNativeEl.value = 'updatedValue';
         dispatchEvent(inputNativeEl, 'input');
@@ -3489,7 +3489,7 @@ const ValueAccessorB = createControlValueAccessor('[cva-b]');
         const inputNativeEl = inputEl.nativeElement;
         expect(inputNativeEl.value).toEqual('oldValue');
 
-        inputEl.triggerEventHandler('compositionstart', null);
+        inputEl.triggerEventHandler('compositionstart');
 
         inputNativeEl.value = 'updatedValue';
         dispatchEvent(inputNativeEl, 'input');
@@ -3517,7 +3517,7 @@ const ValueAccessorB = createControlValueAccessor('[cva-b]');
         const inputNativeEl = inputEl.nativeElement;
         expect(inputNativeEl.value).toEqual('oldValue');
 
-        inputEl.triggerEventHandler('compositionstart', null);
+        inputEl.triggerEventHandler('compositionstart');
 
         inputNativeEl.value = 'updatedValue';
         dispatchEvent(inputNativeEl, 'input');
diff --git a/packages/forms/test/template_integration_spec.ts b/packages/forms/test/template_integration_spec.ts
@@ -2511,7 +2511,7 @@ import {NgModelCustomComp, NgModelCustomWrapper} from './value_accessor_integrat
            tick();
            expect(inputNativeEl.value).toEqual('oldValue');
 
-           inputEl.triggerEventHandler('compositionstart', null);
+           inputEl.triggerEventHandler('compositionstart');
 
            inputNativeEl.value = 'updatedValue';
            dispatchEvent(inputNativeEl, 'input');
@@ -2546,7 +2546,7 @@ import {NgModelCustomComp, NgModelCustomWrapper} from './value_accessor_integrat
            tick();
            expect(inputNativeEl.value).toEqual('oldValue');
 
-           inputEl.triggerEventHandler('compositionstart', null);
+           inputEl.triggerEventHandler('compositionstart');
 
            inputNativeEl.value = 'updatedValue';
            dispatchEvent(inputNativeEl, 'input');
@@ -2578,7 +2578,7 @@ import {NgModelCustomComp, NgModelCustomWrapper} from './value_accessor_integrat
            tick();
            expect(inputNativeEl.value).toEqual('oldValue');
 
-           inputEl.triggerEventHandler('compositionstart', null);
+           inputEl.triggerEventHandler('compositionstart');
 
            inputNativeEl.value = 'updatedValue';
            dispatchEvent(inputNativeEl, 'input');

Original file line number	Diff line number	Diff line change
`@@ -320,7 +320,7 @@ export class DebugElement extends DebugNode {`
`320`	`320`	`get styles(): {`
`321`	`321`	`[key: string]: string \| null;`
`322`	`322`	`};`
`323`		`- triggerEventHandler(eventName: string, eventObj: any): void;`
	`323`	`+ triggerEventHandler(eventName: string, eventObj?: any): void;`
`324`	`324`	`}`
`325`	`325`
`326`	`326`	`// @public (undocumented)`
Original file line number	Diff line number	Diff line change
`@@ -343,7 +343,7 @@ export class DebugElement extends DebugNode {`
`343`	`343`	`*`
`344`	`344`	`* @see [Testing components scenarios](guide/testing-components-scenarios#trigger-event-handler)`
`345`	`345`	`*/`
`346`		`- triggerEventHandler(eventName: string, eventObj: any): void {`
	`346`	`+ triggerEventHandler(eventName: string, eventObj?: any): void {`
`347`	`347`	`const node = this.nativeNode as any;`
`348`	`348`	`const invokedListeners: Function[] = [];`
`349`	`349`