Interface Event

An event which takes place in the DOM.

interface Event {
    bubbles: boolean;
    cancelBubble: (() => void);
    cancelable: boolean;
    composed: boolean;
    currentTarget: null | EventTarget;
    defaultPrevented: boolean;
    eventPhase: 0 | 2;
    isTrusted: boolean;
    returnValue: boolean;
    srcElement: null | EventTarget;
    target: null | EventTarget;
    timeStamp: number;
    type: string;
    composedPath(): [EventTarget?];
    preventDefault(): void;
    stopImmediatePropagation(): void;
    stopPropagation(): void;
}

Hierarchy (view full)

Properties

bubbles cancelBubble cancelable composed currentTarget defaultPrevented eventPhase isTrusted returnValue srcElement target timeStamp type

Methods

composedPath preventDefault stopImmediatePropagation stopPropagation

Properties

Readonly bubbles

bubbles: boolean

This is not used in Node.js and is provided purely for completeness.

cancelBubble

cancelBubble: (() => void)

Alias for event.stopPropagation(). This is not used in Node.js and is provided purely for completeness.

Type declaration

    • (): void

    • Alias for event.stopPropagation(). This is not used in Node.js and is provided purely for completeness.

      Returns void

Readonly cancelable

cancelable: boolean

True if the event was created with the cancelable option

Readonly composed

composed: boolean

This is not used in Node.js and is provided purely for completeness.

Readonly currentTarget

currentTarget: null | EventTarget

Alias for event.target.

Readonly defaultPrevented

defaultPrevented: boolean

Is true if cancelable is true and event.preventDefault() has been called.

Readonly eventPhase

eventPhase: 0 | 2

This is not used in Node.js and is provided purely for completeness.

Readonly isTrusted

isTrusted: boolean

The AbortSignal "abort" event is emitted with isTrusted set to true. The value is false in all other cases.

returnValue

returnValue: boolean

This is not used in Node.js and is provided purely for completeness.

Readonly srcElement

srcElement: null | EventTarget

Alias for event.target.

Readonly target

target: null | EventTarget

The EventTarget dispatching the event

Readonly timeStamp

timeStamp: number

The millisecond timestamp when the Event object was created.

Readonly type

type: string

Returns the type of event, e.g. "click", "hashchange", or "submit".

Methods

composedPath

  • composedPath(): [EventTarget?]

  • Returns an array containing the current EventTarget as the only entry or empty if the event is not being dispatched. This is not used in Node.js and is provided purely for completeness.

    Returns [EventTarget?]

preventDefault

  • preventDefault(): void

  • Sets the defaultPrevented property to true if cancelable is true.

    Returns void

stopImmediatePropagation

  • stopImmediatePropagation(): void

  • Stops the invocation of event listeners after the current one completes.

    Returns void

stopPropagation

  • stopPropagation(): void

  • This is not used in Node.js and is provided purely for completeness.

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc