on | /lib/mod.ts | effection@4.0.0-alpha.1

Module

x/effection/lib/mod.ts>on

Structured concurrency and effects for JavaScript

thefrontside/effection

Latest

mod.ts (default module)

all

run

lazyPromiseWithResolvers

function on

import { on } from "https://deno.land/x/effection@4.0.0-alpha.1/lib/mod.ts";

on<T extends EventTarget, K extends EventList<T> | (string & { })>(target: T, name: K): Stream<EventTypeFromEventTarget<T, K>, never>

Create a Stream of events from any EventTarget.

See the guide on Streams and Subscriptions for details on how to use streams.

Type Parameters

T extends EventTarget

K extends EventList<T> | (string & { })

Parameters

target: T

the event target whose events will be streamed

name: K

the name of the event to stream. E.g. "click"

Returns

Stream<EventTypeFromEventTarget<T, K>, never>

a stream that will see one item for each event