EventHandler

Import

import { EventHandler } from "@typed/template";

This public exposure is a re-export. Its import path is supported; declaration documentation is shared with the other public exposures below.

Signatures

export * as EventHandler from "./EventHandler.js";

Members

• EventHandler.Error

  Extracts the typed error channel of an EventHandler.

• EventHandler.EventHandler

  Represents a DOM event handler that returns an Effect.

  It encapsulates the event handler logic and any options (like preventDefault, once, etc.) that should be applied when the event is triggered.

• EventHandler.EventHandlerTypeId

  The global symbol used to identify EventHandler values across module copies.

• EventHandler.EventOf

  Extracts the native event type accepted by an EventHandler.

• EventHandler.EventOptions

  Options for applying native event behavior before an Effect handler runs.

• EventHandler.Services

  Extracts the Effect service requirements of an EventHandler.

• EventHandler.catchCause

  Recovers from errors in the EventHandler.

• EventHandler.fromEffectOrEventHandler

  Helper to ensure a value is an EventHandler.

  If the input is already an EventHandler, it is returned as is. If it is an Effect, it is wrapped in an EventHandler that ignores the event argument.

• EventHandler.handleEventOptions

  Applies event options to a native DOM event.

• EventHandler.isEventHandler

  Checks if a value is an EventHandler.

• EventHandler.make

  Creates a new EventHandler.

• EventHandler.once

  Modifies an EventHandler to run only once.

• EventHandler.passive

  Modifies an EventHandler to be passive (improves scrolling performance).

• EventHandler.preventDefault

  Modifies an EventHandler to call preventDefault() on the event.

• EventHandler.provide

  Provides services to the EventHandler.

  This allows you to inject dependencies into the effect returned by the event handler.

• EventHandler.stopImmediatePropagation

  Modifies an EventHandler to call stopImmediatePropagation() on the event.

• EventHandler.stopPropagation

  Modifies an EventHandler to call stopPropagation() on the event.

Source

• packages/template/src/EventHandler.ts:19