Skip to main content
Module

x/typescript_event_target/mod.ts>TypedEventTarget

Strictly typed EventTarget which works with all Event-Types and extends EventTarget directly to allow effortless migration with basically no additional bundle-size.
DerZade/typescript-event-target
Go to Latest
class TypedEventTarget
extends EventTarget
import { TypedEventTarget } from "https://deno.land/x/typescript_event_target@v1.0.2/mod.ts";

Type Parameters

M extends ValueIsEvent<M>

Methods

dispatchTypedEvent<T extends keyof M>(_type: T, event: M[T]): boolean

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

interface TypedEventTarget
import { type TypedEventTarget } from "https://deno.land/x/typescript_event_target@v1.0.2/mod.ts";

Type Parameters

M extends ValueIsEvent<M>

Properties

addEventListener: <T extends keyof M & string>(
type: T,
listener: TypedEventListenerOrEventListenerObject<M, T> | null,
options?: boolean | AddEventListenerOptions,
) => void

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

removeEventListener: <T extends keyof M & string>(
type: T,
callback: TypedEventListenerOrEventListenerObject<M, T> | null,
options?: EventListenerOptions | boolean,
) => void

Removes the event listener in target's event listener list with the same type, callback, and options.

deprecated
dispatchEvent: (event: Event) => boolean

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.