eventsource - npm Package Compare versions

Comparing version 3.0.2 to 3.0.3

dist/index.d.ts

@@ -1,2 +0,14 @@
-/// <reference path="events.d.ts" />
+/**
+ * Mirrors the official DOM typings (sorta).
+ *
+ * @public
+ */
+export declare 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
+}
 
@@ -28,2 +40,37 @@ /**
 /**
+ * Mirrors the official DOM typings.
+ *
+ * @public
+ */
+export declare interface EventListener {
+  (evt: Event | MessageEvent): void
+}
+
+/**
+ * Mirrors the official DOM typings.
+ *
+ * @public
+ */
+export declare interface EventListenerObject {
+  handleEvent(object: Event): void
+}
+
+/**
+ * Mirrors the official DOM typings (sorta).
+ *
+ * @public
+ */
+export declare interface EventListenerOptions {
+  /** Not directly used by Node.js. Added for API completeness. Default: `false`. */
+  capture?: boolean
+}
+
+/**
+ * Mirrors the official DOM typings.
+ *
+ * @public
+ */
+export declare type EventListenerOrEventListenerObject = EventListener | EventListenerObject
+
+/**
  * An `EventSource` instance opens a persistent connection to an HTTP server, which sends events
@@ -30,0 +77,0 @@ * in `text/event-stream` format. The connection remains open until closed by calling `.close()`.

package.json

 {
   "name": "eventsource",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "description": "WhatWG/W3C compliant EventSource client for Node.js and browsers",
@@ -22,3 +22,3 @@ "sideEffects": false,
   "scripts": {
-    "build": "pkg-utils build && pkg-utils --strict && tsx scripts/referenceEventTypings.ts",
+    "build": "pkg-utils build && pkg-utils --strict",
     "build:watch": "pkg-utils watch",
@@ -25,0 +25,0 @@ "clean": "rimraf dist coverage",

README.md

@@ -74,2 +74,24 @@ # eventsource
 
+### 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.
+
+The following errors are caused by targetting an environment that does not have the necessary types available:
+
+```
+error TS2304: Cannot find name 'Event'.
+error TS2304: Cannot find name 'EventTarget'.
+error TS2304: Cannot find name 'MessageEvent'.
+```
+
 ## Migrating from v1 / v2
@@ -76,0 +98,0 @@

src/EventSource.ts

@@ -5,2 +5,5 @@ import {createParser, type EventSourceMessage, type EventSourceParser} from 'eventsource-parser'
 import type {
+  AddEventListenerOptions,
+  EventListenerOptions,
+  EventListenerOrEventListenerObject,
   EventSourceEventMap,
@@ -7,0 +10,0 @@ EventSourceInit,

src/types.ts

@@ -89,1 +89,50 @@ import type {ErrorEvent} from './errors.js'
 }
+
+/**
+ * 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
+}

No alert changes

Improved metrics

Number of lines in readme file

168

increased by15.07%

Worsened metrics

Total package byte prevSize

127232

decreased by-5.38%

Number of package files

13

decreased by-13.33%

Lines of code

1431

decreased by-11.83%

No dependency changes