chore(event-spy): update event name & documentation (#18)

Author: tanner-reits

src/index.ts

@@ -1,6 +1,6 @@
 export * from './create-config';
 export * from './matchers';
-export * from './page/event-spy';
+export type { EventSpy } from './page/event-spy';
 export * from './page/utils';
 export * from './playwright-declarations';
 export * from './playwright-page';

src/page/event-spy.ts

@@ -60,8 +60,10 @@ export class EventSpy {
 }
 
 /**
+ * For internal use only.
+ *
  * Initializes information required to spy on events.
- * The ionicOnEvent function is called in the context of the current page.
+ * The stencilOnEvent function is called in the context of the current page.
  * This lets us respond to an event listener created within the page itself.
  *
  * @param page The Playwright test page object.
@@ -70,7 +72,7 @@ export const initPageEvents = async (page: E2EPage) => {
   page._e2eEventsIds = 0;
   page._e2eEvents = new Map();
 
-  await page.exposeFunction('ionicOnEvent', (id: number, ev: any) => {
+  await page.exposeFunction('stencilOnEvent', (id: number, ev: any) => {
     const context = page._e2eEvents.get(id);
     if (context) {
       context.callback(ev);
@@ -79,6 +81,8 @@ export const initPageEvents = async (page: E2EPage) => {
 };
 
 /**
+ * For internal use only.
+ *
  * Adds a new event listener in the current page context to updates
  * the _e2eEvents map when an event is fired.
  *
@@ -149,7 +153,7 @@ export const addE2EListener = async (
       };
 
       elm.addEventListener(eventName as string, (ev: Event) => {
-        (window as any).ionicOnEvent(id, (window as any).serializeStencilEvent(ev));
+        (window as any).stencilOnEvent(id, (window as any).serializeStencilEvent(ev));
       });
     },
     [eventName, id],

src/playwright-declarations.ts

@@ -54,8 +54,8 @@ export interface E2EPage extends Page {
    * [upstream issue](https://bugs.chromium.org/p/chromium/issues/detail?id=761295).
    *
    * Shortcut for main frame's [frame.goto(url[, options])](https://playwright.dev/docs/api/class-frame#frame-goto)
-   * @param url URL to navigate page to. The url should include scheme, e.g. `https://`. When a `baseURL` via the context options was provided and the passed URL is a path, it gets merged via the
-   * [`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor.
+   * @param url URL to navigate page to. The url should include scheme, e.g. `https://`. When a `baseURL` via the context options was
+   * provided and the passed URL is a path, it gets merged via the [`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor.
    */
   goto: (url: string, options?: E2EPageOptions) => Promise<null | Response>;
 
@@ -83,10 +83,8 @@ export interface E2EPage extends Page {
    */
   waitForChanges: (timeoutMs?: number) => Promise<void>;
   /**
-   * Creates a new EventSpy and listens
-   * on the window for an event.
-   * The test will timeout if the event
-   * never fires.
+   * Creates a new EventSpy and listens on the window for an event.
+   * The test will timeout if the event never fires.
    *
    * Usage:
    * ```ts