Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "from/event"

Index

Functions

Const fromDOMEvent

  • fromDOMEvent<K>(src: EventTarget, name: K, listenerOpts?: boolean | AddEventListenerOptions, streamOpts?: Partial<CommonOpts>): Stream<GlobalEventHandlersEventMap[K]>
  • Same as fromEvent, however only supports well-known DOM event names. Returned stream instance will use corresponding concrete event type in its type signature, whereas fromEvent will only use the generic Event.

    example
    fromDOMEvent(document.body, "mousemove"); // Stream<MouseEvent>
    fromEvent(document.body, "mousemove"); // Stream<Event>

    Also see: fromEvent

    Type parameters

    • K: keyof GlobalEventHandlersEventMap

    Parameters

    • src: EventTarget

      -

    • name: K

      -

    • Default value listenerOpts: boolean | AddEventListenerOptions = false

      -

    • Optional streamOpts: Partial<CommonOpts>

      -

    Returns Stream<GlobalEventHandlersEventMap[K]>

Const fromEvent

  • fromEvent(src: EventTarget, name: string, listenerOpts?: boolean | AddEventListenerOptions, streamOpts?: Partial<CommonOpts>): Stream<Event>
  • Creates a Stream of events attached to given element / event target and using given event listener options (same as supported by addEventListener(), default: false).

    Parameters

    • src: EventTarget

      event target

    • name: string

      event name

    • Default value listenerOpts: boolean | AddEventListenerOptions = false

      listener opts

    • Optional streamOpts: Partial<CommonOpts>

      stream opts

    Returns Stream<Event>

Generated using TypeDoc