Function fromDOMEvent

  • fromDOMEvent<K>(element, type, options?, queuingStrategy?): ReadableStream<WindowEventMap[K]>

  • Creates a readable stream from DOM events.

    Type Parameters

    • K extends keyof WindowEventMap

    Parameters

    • element: Window
    • type: K
    • Optional options: boolean | AddEventListenerOptions
    • Optional queuingStrategy: QueuingStrategy<WindowEventMap[K]>

    Returns ReadableStream<WindowEventMap[K]>

    Example

    fromDOMEvent(window, 'resize')
    fromDOMEvent(document, 'click', { capture: true })

    If you're receiving an excessive amount of events and find that some are being dropped, you may wish to increase the high water mark.

    fromDOMEvent(
      document.body,
      'mousemove',
      {},
      new CountQueuingStrategy({ highWaterMark: 100 })
    )
  • fromDOMEvent<K>(element, type, options?, queuingStrategy?): ReadableStream<DocumentEventMap[K]>

  • Type Parameters

    • K extends keyof DocumentEventMap

    Parameters

    • element: Document
    • type: K
    • Optional options: boolean | AddEventListenerOptions
    • Optional queuingStrategy: QueuingStrategy<DocumentEventMap[K]>

    Returns ReadableStream<DocumentEventMap[K]>

  • fromDOMEvent<K>(element, type, options?, queuingStrategy?): ReadableStream<HTMLElementEventMap[K]>

  • Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • element: HTMLElement
    • type: K
    • Optional options: boolean | AddEventListenerOptions
    • Optional queuingStrategy: QueuingStrategy<HTMLElementEventMap[K]>

    Returns ReadableStream<HTMLElementEventMap[K]>

  • fromDOMEvent(element, type, options?, queuingStrategy?): ReadableStream<Event>

  • Parameters

    • element: Document | HTMLElement | Window
    • type: string
    • Optional options: boolean | AddEventListenerOptions
    • Optional queuingStrategy: QueuingStrategy<Event>

    Returns ReadableStream<Event>

Settings

Member Visibility

Theme

Generated using TypeDoc