Skip to main content
Module

x/evtemitter/mod.ts>default#subscribe

Eventemitter for deno.
apollo79/evtemitter
Go to Latest
method default.prototype.subscribe
import { default } from "https://deno.land/x/evtemitter@v3.0.0/mod.ts";

Subscribe method. Returns a cleanup function to remove the added EventListener

Type Parameters

Ev extends ReservedOrUserEventNames<ReservedEvents, UserEvents>

Parameters

type: Ev

the event name the callback should listen to

callback: ReservedOrUserListenerOn<ReservedEvents, UserEvents, Ev>

the callback to execute when the event is dispatched

optional
options: Parameters<EventTarget["addEventListener"]>[2]

event options EventTarget["addEventListener"]

Returns

Fn<never, void>

cleanup function