@thi.ng/rstream/event.d.ts

Reactive streams & subscription primitives for constructing dataflow graphs / pipelines

import type { CommonOpts } from "./api.js";
import { Stream } from "./stream.js";
export interface EventOpts<T extends Event = Event> extends CommonOpts {
    /**
     * If given, the event stream will be seeded with this (presumably
     * compatible event-like) value.
     */
    init: T;
}
/**
 * Creates a {@link Stream} of events attached to given element / event
 * target and using given event listener options (same as supported by
 * `addEventListener()`, default: false).
 *
 * @param src - event target
 * @param name - event name
 * @param listenerOpts - listener opts
 * @param streamOpts - stream opts
 */
export declare const fromEvent: (src: EventTarget, name: string, listenerOpts?: boolean | AddEventListenerOptions, streamOpts?: Partial<EventOpts>) => Stream<Event>;
/**
 * Same as {@link fromEvent}, however only supports well-known DOM event
 * names. Returned stream instance will use corresponding concrete event
 * type in its type signature, whereas {@link fromEvent} will only use the
 * generic `Event`.
 *
 * @example
 * ```ts
 * import { fromDOMEvent, fromEvent } from "@thi.ng/rstream";
 *
 * fromDOMEvent(document.body, "mousemove"); // Stream<MouseEvent>
 * fromEvent(document.body, "mousemove"); // Stream<Event>
 * ```
 *
 * @param src -
 * @param name -
 * @param listenerOpts -
 * @param streamOpts -
 */
export declare const fromDOMEvent: <K extends keyof GlobalEventHandlersEventMap>(src: EventTarget, name: K, listenerOpts?: boolean | AddEventListenerOptions, streamOpts?: Partial<EventOpts<GlobalEventHandlersEventMap[K]>>) => Stream<GlobalEventHandlersEventMap[K]>;
//# sourceMappingURL=event.d.ts.map