fix: bundle event listener typings

Author: rexxars

README.md

@@ -71,6 +71,20 @@ setTimeout(() => {
 }, 10_000)
 ```
 
+### TypeScript
+
+Make sure you have configured your TSConfig so it matches the environment you are targetting. If you are targetting browsers, this would be `dom`:
+
+```jsonc
+{
+  "compilerOptions": {
+    "lib": ["dom"],
+  },
+}
+```
+
+If you're using Node.js, ensure you have `@types/node` installed (and it is version 18 or higher). Cloudflare workers have `@cloudflare/workers-types` etc.
+
 ## Migrating from v1 / v2
 
 See [MIGRATION.md](MIGRATION.md#v2-to-v3) for a detailed migration guide.

package.json

@@ -19,7 +19,7 @@
     "./package.json": "./package.json"
   },
   "scripts": {
-    "build": "pkg-utils build && pkg-utils --strict && tsx scripts/referenceEventTypings.ts",
+    "build": "pkg-utils build && pkg-utils --strict",
     "build:watch": "pkg-utils watch",
     "clean": "rimraf dist coverage",
     "lint": "eslint . && tsc --noEmit",

scripts/referenceEventTypings.ts

@@ -2,6 +2,9 @@ import {createParser, type EventSourceMessage, type EventSourceParser} from 'eve
 
 import {ErrorEvent, syntaxError} from './errors.js'
 import type {
+  AddEventListenerOptions,
+  EventListenerOptions,
+  EventListenerOrEventListenerObject,
   EventSourceEventMap,
   EventSourceInit,
   FetchLike,

src/EventSource.ts

@@ -86,3 +86,52 @@ export interface EventSourceInit {
    */
   fetch?: FetchLike
 }
+
+/**
+ * Mirrors the official DOM typings (sorta).
+ *
+ * @public
+ */
+export interface EventListenerOptions {
+  /** Not directly used by Node.js. Added for API completeness. Default: `false`. */
+  capture?: boolean
+}
+
+/**
+ * Mirrors the official DOM typings (sorta).
+ *
+ * @public
+ */
+export interface AddEventListenerOptions extends EventListenerOptions {
+  /** When `true`, the listener is automatically removed when it is first invoked. Default: `false`. */
+  once?: boolean
+  /** When `true`, serves as a hint that the listener will not call the `Event` object's `preventDefault()` method. Default: false. */
+  passive?: boolean
+  /** The listener will be removed when the given AbortSignal object's `abort()` method is called. */
+  signal?: AbortSignal
+}
+
+/**
+ * Mirrors the official DOM typings.
+ *
+ * @public
+ */
+export type EventListenerOrEventListenerObject = EventListener | EventListenerObject
+
+/**
+ * Mirrors the official DOM typings.
+ *
+ * @public
+ */
+export interface EventListener {
+  (evt: Event | MessageEvent): void
+}
+
+/**
+ * Mirrors the official DOM typings.
+ *
+ * @public
+ */
+export interface EventListenerObject {
+  handleEvent(object: Event): void
+}