Skip to content

PushEvent

Types

t

type t = PushTypes.pushEvent = {
type_: EventTypes.eventType,
target: Null.t<EventTypes.eventTarget>,
currentTarget: Null.t<EventTypes.eventTarget>,
eventPhase: int,
bubbles: bool,
cancelable: bool,
defaultPrevented: bool,
composed: bool,
isTrusted: bool,
timeStamp: float,
data?: PushTypes.pushMessageData,
}

Record fields

type_
EventTypes.eventType

Returns the type of event, e.g. "click", "hashchange", or "submit". Read more on MDN

target
Null.t< EventTypes.eventTarget >

Returns the object to which event is dispatched (its target). Read more on MDN

currentTarget
Null.t< EventTypes.eventTarget >

Returns the object whose event listener's callback is currently being invoked. Read more on MDN

eventPhase
int

Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE. Read more on MDN

bubbles
bool

Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise. Read more on MDN

cancelable
bool

Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method. Read more on MDN

defaultPrevented
bool

Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise. Read more on MDN

composed
bool

Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise. Read more on MDN

isTrusted
bool

Returns true if event was dispatched by the user agent, and false otherwise. Read more on MDN

timeStamp
float

Returns the event's timestamp as the number of milliseconds measured relative to the time origin. Read more on MDN

data
option< PushTypes.pushMessageData >

Values

asEvent

let asEvent: t => EventTypes.event

Parameters

t

Return type

EventTypes.event

asExtendableEvent

let asExtendableEvent: t => EventTypes.extendableEvent

Parameters

t

Return type

EventTypes.extendableEvent

composedPath

Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget. Read more on MDN

let composedPath: t => array<EventTypes.eventTarget>

Parameters

t

Return type

array< EventTypes.eventTarget >

preventDefault

If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled. Read more on MDN

let preventDefault: t => unit

Parameters

t

Return type

unit

stopImmediatePropagation

Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects. Read more on MDN

let stopImmediatePropagation: t => unit

Parameters

t

Return type

unit

stopPropagation

When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object. Read more on MDN

let stopPropagation: t => unit

Parameters

t

Return type

unit

waitUntil

let waitUntil: (t, promise<'a>) => unit

Parameters

t promise

Return type

unit