better-sse 0.15.0 → 0.15.1

package/README.md

@@ -1,10 +1,19 @@
 # Better SSE
 
 <p>
-	<img src="https://img.shields.io/npm/v/better-sse?color=blue&style=flat-square" />
-	<img src="https://img.shields.io/npm/l/better-sse?color=green&style=flat-square" />
-	<img src="https://img.shields.io/npm/dt/better-sse?color=grey&style=flat-square" />
-	<a href="https://github.com/MatthewWid/better-sse"><img src="https://img.shields.io/github/stars/MatthewWid/better-sse?style=social" /></a>
+    <a href="https://www.npmjs.com/package/better-sse">
+        <img src="https://img.shields.io/npm/v/better-sse?color=blue&style=flat-square" alt="npm" />
+    </a>
+    <a href="https://jsr.io/@mwid/better-sse">
+        <img src="https://jsr.io/badges/@mwid/better-sse" alt="jsr" />
+    </a>
+    <a href="https://github.com/MatthewWid/better-sse/blob/master/LICENSE">
+        <img src="https://img.shields.io/npm/l/better-sse?color=green&style=flat-square" alt="MIT license" />
+    </a>
+	<img src="https://img.shields.io/npm/dt/better-sse?color=grey&style=flat-square" alt="Downloads" />
+	<a href="https://github.com/MatthewWid/better-sse">
+        <img src="https://img.shields.io/github/stars/MatthewWid/better-sse?style=social" alt="GitHub stars" />
+    </a>
 </p>
 
 A dead simple, dependency-less, spec-compliant server-sent events implementation written in TypeScript.
@@ -47,7 +56,7 @@ Read the [Getting Started](https://matthewwid.github.io/better-sse/guides/gettin
 
 # Installation
 
-Install with any package manager:
+Better SSE is published as a package on [npm](https://www.npmjs.com/package/better-sse) and the [JSR](https://jsr.io/@mwid/better-sse). You can install it with any package manager:
 
 ```sh
 npm install better-sse
@@ -66,7 +75,7 @@ bun add better-sse
 ```
 
 ```sh
-deno install npm:better-sse
+deno install jsr:@mwid/better-sse
 ```
 
 _Better SSE ships with types built in. No need to install from DefinitelyTyped for TypeScript users!_

package/build/index.d.mts

@@ -1,6 +1,6 @@
-import * as stream from 'stream';
 import { IncomingMessage, ServerResponse } from 'node:http';
 import { Http2ServerRequest, Http2ServerResponse } from 'node:http2';
+import { Readable } from 'node:stream';
 import { EventEmitter } from 'node:events';
 
 interface IterateOptions {
@@ -11,7 +11,9 @@ interface IterateOptions {
      */
     eventName?: string;
 }
+type PushFromIterable = (iterable: Iterable<unknown> | AsyncIterable<unknown>, options?: IterateOptions) => Promise<void>;
 
+type WebReadableStream = ReadableStream;
 interface StreamOptions {
     /**
      * Event name/type to be emitted when stream data is sent to the client.
@@ -20,6 +22,7 @@ interface StreamOptions {
      */
     eventName?: string;
 }
+type PushFromStream = (stream: Readable | WebReadableStream, options?: StreamOptions) => Promise<boolean>;
 
 type SanitizerFunction = (text: string) => string;
 
@@ -118,9 +121,9 @@ declare class EventBuffer {
      * @param stream - Readable stream to consume data from.
      * @param options - Event name to use for each event created.
      *
-     * @returns A promise that resolves or rejects based on the success of the stream write finishing.
+     * @returns A promise that resolves with `true` or rejects based on the success of the stream write finishing.
      */
-    stream: (stream: stream.Readable | ReadableStream<any>, options?: StreamOptions) => Promise<boolean>;
+    stream: PushFromStream;
     /**
      * Iterate over an iterable and write yielded values as events into the buffer.
      *
@@ -132,7 +135,7 @@ declare class EventBuffer {
      *
      * @returns A promise that resolves once all data has been successfully yielded from the iterable.
      */
-    iterate: <DataType = unknown>(iterable: Iterable<DataType> | AsyncIterable<DataType>, options?: IterateOptions) => Promise<void>;
+    iterate: PushFromIterable;
     /**
      * Clear the contents of the buffer.
      */
@@ -339,9 +342,9 @@ declare class Session<State = DefaultSessionState> extends TypedEmitter<SessionE
      * @param stream - Readable stream to consume data from.
      * @param options - Options to alter how the stream is flushed to the client.
      *
-     * @returns A promise that resolves or rejects based on the success of the stream write finishing.
+     * @returns A promise that resolves with `true` or rejects based on the success of the stream write finishing.
      */
-    stream: (stream: stream.Readable | ReadableStream<any>, options?: StreamOptions) => Promise<boolean>;
+    stream: PushFromStream;
     /**
      * Iterate over an iterable and send yielded values as events to the client.
      *
@@ -353,7 +356,7 @@ declare class Session<State = DefaultSessionState> extends TypedEmitter<SessionE
      *
      * @returns A promise that resolves once all data has been successfully yielded from the iterable.
      */
-    iterate: <DataType = unknown>(iterable: Iterable<DataType> | AsyncIterable<DataType>, options?: IterateOptions) => Promise<void>;
+    iterate: PushFromIterable;
     /**
      * Batch and send multiple events at once.
      *

package/build/index.d.ts

@@ -1,6 +1,6 @@
-import * as stream from 'stream';
 import { IncomingMessage, ServerResponse } from 'node:http';
 import { Http2ServerRequest, Http2ServerResponse } from 'node:http2';
+import { Readable } from 'node:stream';
 import { EventEmitter } from 'node:events';
 
 interface IterateOptions {
@@ -11,7 +11,9 @@ interface IterateOptions {
      */
     eventName?: string;
 }
+type PushFromIterable = (iterable: Iterable<unknown> | AsyncIterable<unknown>, options?: IterateOptions) => Promise<void>;
 
+type WebReadableStream = ReadableStream;
 interface StreamOptions {
     /**
      * Event name/type to be emitted when stream data is sent to the client.
@@ -20,6 +22,7 @@ interface StreamOptions {
      */
     eventName?: string;
 }
+type PushFromStream = (stream: Readable | WebReadableStream, options?: StreamOptions) => Promise<boolean>;
 
 type SanitizerFunction = (text: string) => string;
 
@@ -118,9 +121,9 @@ declare class EventBuffer {
      * @param stream - Readable stream to consume data from.
      * @param options - Event name to use for each event created.
      *
-     * @returns A promise that resolves or rejects based on the success of the stream write finishing.
+     * @returns A promise that resolves with `true` or rejects based on the success of the stream write finishing.
      */
-    stream: (stream: stream.Readable | ReadableStream<any>, options?: StreamOptions) => Promise<boolean>;
+    stream: PushFromStream;
     /**
      * Iterate over an iterable and write yielded values as events into the buffer.
      *
@@ -132,7 +135,7 @@ declare class EventBuffer {
      *
      * @returns A promise that resolves once all data has been successfully yielded from the iterable.
      */
-    iterate: <DataType = unknown>(iterable: Iterable<DataType> | AsyncIterable<DataType>, options?: IterateOptions) => Promise<void>;
+    iterate: PushFromIterable;
     /**
      * Clear the contents of the buffer.
      */
@@ -339,9 +342,9 @@ declare class Session<State = DefaultSessionState> extends TypedEmitter<SessionE
      * @param stream - Readable stream to consume data from.
      * @param options - Options to alter how the stream is flushed to the client.
      *
-     * @returns A promise that resolves or rejects based on the success of the stream write finishing.
+     * @returns A promise that resolves with `true` or rejects based on the success of the stream write finishing.
      */
-    stream: (stream: stream.Readable | ReadableStream<any>, options?: StreamOptions) => Promise<boolean>;
+    stream: PushFromStream;
     /**
      * Iterate over an iterable and send yielded values as events to the client.
      *
@@ -353,7 +356,7 @@ declare class Session<State = DefaultSessionState> extends TypedEmitter<SessionE
      *
      * @returns A promise that resolves once all data has been successfully yielded from the iterable.
      */
-    iterate: <DataType = unknown>(iterable: Iterable<DataType> | AsyncIterable<DataType>, options?: IterateOptions) => Promise<void>;
+    iterate: PushFromIterable;
     /**
      * Batch and send multiple events at once.
      *

package/build/index.js

@@ -200,7 +200,7 @@ var EventBuffer = class {
    * @param stream - Readable stream to consume data from.
    * @param options - Event name to use for each event created.
    *
-   * @returns A promise that resolves or rejects based on the success of the stream write finishing.
+   * @returns A promise that resolves with `true` or rejects based on the success of the stream write finishing.
    */
   stream = createPushFromStream(this.push);
   /**
@@ -624,7 +624,7 @@ var Session = class extends TypedEmitter {
    * @param stream - Readable stream to consume data from.
    * @param options - Options to alter how the stream is flushed to the client.
    *
-   * @returns A promise that resolves or rejects based on the success of the stream write finishing.
+   * @returns A promise that resolves with `true` or rejects based on the success of the stream write finishing.
    */
   stream = createPushFromStream(this.push);
   /**

package/build/index.mjs

@@ -170,7 +170,7 @@ var EventBuffer = class {
    * @param stream - Readable stream to consume data from.
    * @param options - Event name to use for each event created.
    *
-   * @returns A promise that resolves or rejects based on the success of the stream write finishing.
+   * @returns A promise that resolves with `true` or rejects based on the success of the stream write finishing.
    */
   stream = createPushFromStream(this.push);
   /**
@@ -594,7 +594,7 @@ var Session = class extends TypedEmitter {
    * @param stream - Readable stream to consume data from.
    * @param options - Options to alter how the stream is flushed to the client.
    *
-   * @returns A promise that resolves or rejects based on the success of the stream write finishing.
+   * @returns A promise that resolves with `true` or rejects based on the success of the stream write finishing.
    */
   stream = createPushFromStream(this.push);
   /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "better-sse",
   "description": "Dead simple, dependency-less, spec-compliant server-sent events implementation written in TypeScript.",
-  "version": "0.15.0",
+  "version": "0.15.1",
   "license": "MIT",
   "author": "Matthew W. <matthew.widdi@gmail.com>",
   "repository": "github:MatthewWid/better-sse",