EventTarget: dispatchEvent() method

فهرست فصل‌ها دانلود آرشیوناشر

MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونه‌کد

{{APIRef("DOM")}}{{AvailableInWorkers}}

The **dispatchEvent()** method of the {{domxref("EventTarget")}} sends an {{domxref("Event")}} to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

Calling dispatchEvent() is the last step to _firing an event_. The event should have already been created and initialized using an {{domxref("Event/Event", "Event()")}} constructor.

توجه: When calling this method, the {{domxref("Event.target")}} property is initialized to the current EventTarget.

Unlike "native" events, which the browser fires by queuing a task on the event loop, dispatchEvent() invokes all applicable event handlers synchronously before returning. The read-only [isTrusted](/en-US/docs/Web/API/Event/isTrusted) property is true for native events and false for events dispatched with dispatchEvent().

Syntax

js-nolint
dispatchEvent(event)

Parameters

  • event
  • : The {{domxref("Event")}} object to dispatch. Its {{domxref("Event.target")}} property will be set to the current {{domxref("EventTarget")}}.

Return value

false if event is cancelable, and at least one of the event handlers which received event called {{domxref("Event.preventDefault()")}}. Otherwise true.

Exceptions

  • InvalidStateError {{domxref("DomException")}}
  • : Thrown if the event's type was not specified during event initialization.

توجه: Exceptions thrown by event handlers are reported as uncaught exceptions. The event handlers run on a nested callstack; they block the caller until they complete, but exceptions do not propagate to the caller.

Example

See Creating and dispatching events.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also