.fromEventListener bufferSize

Effect-TS · Jul 18, 2024 · f464e69 · f464e69
1 parent 9266c7a
commit f464e69
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 6 deletions.
diff --git a/.changeset/beige-rules-argue.md b/.changeset/beige-rules-argue.md
@@ -0,0 +1,6 @@
+---
+"effect": patch
+"@effect/platform-browser": patch
+---
+
+use "unbounded" buffer for Stream.fromEventListener
diff --git a/.changeset/tricky-cheetahs-help.md b/.changeset/tricky-cheetahs-help.md
@@ -0,0 +1,5 @@
+---
+"effect": minor
+---
+
+add `bufferSize` option to Stream.fromEventListener
diff --git a/packages/effect/src/Stream.ts b/packages/effect/src/Stream.ts
@@ -5963,5 +5963,6 @@ export const fromEventListener: <A = unknown>(
     readonly capture?: boolean
     readonly passive?: boolean
     readonly once?: boolean
+    readonly bufferSize?: number | "unbounded" | undefined
   } | undefined
 ) => Stream<A> = internal.fromEventListener
diff --git a/packages/platform-browser/src/BrowserStream.ts b/packages/platform-browser/src/BrowserStream.ts
@@ -11,14 +11,24 @@ import * as internal from "./internal/stream.js"
  */
 export const fromEventListenerWindow: <K extends keyof WindowEventMap>(
   type: K,
-  options?: boolean | Omit<AddEventListenerOptions, "signal">
-) => Stream.Stream<WindowEventMap[K]> = internal.fromEventListenerWindow
+  options?: boolean | {
+    readonly capture?: boolean
+    readonly passive?: boolean
+    readonly once?: boolean
+    readonly bufferSize?: number | "unbounded" | undefined
+  } | undefined
+) => Stream.Stream<WindowEventMap[K], never, never> = internal.fromEventListenerWindow
 
 /**
  * Creates a `Stream` from document.addEventListener.
  * @since 1.0.0
  */
 export const fromEventListenerDocument: <K extends keyof DocumentEventMap>(
   type: K,
-  options?: boolean | Omit<AddEventListenerOptions, "signal">
-) => Stream.Stream<DocumentEventMap[K]> = internal.fromEventListenerDocument
+  options?: boolean | {
+    readonly capture?: boolean
+    readonly passive?: boolean
+    readonly once?: boolean
+    readonly bufferSize?: number | "unbounded" | undefined
+  } | undefined
+) => Stream.Stream<DocumentEventMap[K], never, never> = internal.fromEventListenerDocument
diff --git a/packages/platform-browser/src/internal/stream.ts b/packages/platform-browser/src/internal/stream.ts
@@ -7,11 +7,21 @@ import * as Stream from "effect/Stream"
 /** @internal */
 export const fromEventListenerWindow = <K extends keyof WindowEventMap>(
   type: K,
-  options?: boolean | Omit<AddEventListenerOptions, "signal">
+  options?: boolean | {
+    readonly capture?: boolean
+    readonly passive?: boolean
+    readonly once?: boolean
+    readonly bufferSize?: number | "unbounded" | undefined
+  } | undefined
 ) => Stream.fromEventListener<WindowEventMap[K]>(window, type, options)
 
 /** @internal */
 export const fromEventListenerDocument = <K extends keyof DocumentEventMap>(
   type: K,
-  options?: boolean | Omit<AddEventListenerOptions, "signal">
+  options?: boolean | {
+    readonly capture?: boolean
+    readonly passive?: boolean
+    readonly once?: boolean
+    readonly bufferSize?: number | "unbounded" | undefined
+  } | undefined
 ) => Stream.fromEventListener<DocumentEventMap[K]>(document, type, options)