BrowserStream.ts

BrowserStream.ts overview

Browser DOM event streams.

This module provides typed constructors that turn window.addEventListener and document.addEventListener events into Effect Stream values. Both helpers accept the usual listener options and an optional stream buffer size.

Since v4.0.0

---

Exports Grouped by Category

• streams
  • fromEventListenerDocument
  • fromEventListenerWindow

---

streams

fromEventListenerDocument

Creates a Stream from document.addEventListener.

Details

By default, the underlying buffer is unbounded in size. You can customize the buffer size by passing an object as the second argument with the bufferSize field.

Signature

declare const fromEventListenerDocument: <K extends keyof DocumentEventMap>(
  type: K,
  options?:
    | boolean
    | {
        readonly capture?: boolean
        readonly passive?: boolean
        readonly once?: boolean
        readonly bufferSize?: number | undefined
      }
    | undefined
) => Stream.Stream<DocumentEventMap[K], never, never>

Source

Since v4.0.0

fromEventListenerWindow

Creates a Stream from window.addEventListener.

Details

By default, the underlying buffer is unbounded in size. You can customize the buffer size by passing an object as the second argument with the bufferSize field.

Signature

declare const fromEventListenerWindow: <K extends keyof WindowEventMap>(
  type: K,
  options?:
    | boolean
    | {
        readonly capture?: boolean
        readonly passive?: boolean
        readonly once?: boolean
        readonly bufferSize?: number | undefined
      }
    | undefined
) => Stream.Stream<WindowEventMap[K], never, never>

Source

Since v4.0.0