View source

class CloseEvent

package js.node.web

extends Event

@:native("CloseEvent")

An event that fires when a WebSocket connection closes.

See also:

Constructor

new(type:String, ?eventInitDict:CloseEventInit)

Variables

read onlycode:Int

The WebSocket connection close code.

read onlyreason:String

The reason the WebSocket connection closed.

read onlywasClean:Bool

Whether the connection closed cleanly.

Inherited Variables

Defined by Event

read onlybubbles:Bool

Always returns false in Node.js. Provided purely for completeness.

cancelBubble:Bool

Deprecated: "Use stopPropagation() instead"

Alias for stopPropagation() if set to true.

Stability: 3 - Legacy.

read onlycancelable:Bool

True if the event was created with the cancelable option.

read onlycomposed:Bool

Always returns false in Node.js. Provided purely for completeness.

read onlycurrentTarget:EventTarget

Alias for target.

read onlydefaultPrevented:Bool

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

read onlyeventPhase:Int

Returns 0 while an event is not being dispatched, 2 while it is being dispatched. This is not used in Node.js and is provided purely for completeness.

read onlyisTrusted:Bool

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

returnValue:Bool

Deprecated: "Use defaultPrevented instead"

True if the event has not been canceled.

Stability: 3 - Legacy.

read onlysrcElement:EventTarget

Deprecated: "Use target instead"

Alias for target.

Stability: 3 - Legacy.

read onlytarget:EventTarget

The EventTarget dispatching the event.

read onlytimeStamp:Float

The millisecond timestamp when the Event object was created.

read onlytype:String

The event type identifier.

Inherited Methods

Defined by Event

composedPath():Array<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.

initEvent(type:String, ?bubbles:Bool, ?cancelable:Bool):Void

Deprecated: "Use the Event constructor instead"

Redundant with event constructors and incapable of setting composed.

Stability: 3 - Legacy. The WHATWG spec considers it deprecated.

preventDefault():Void

Sets the defaultPrevented property to true if cancelable is true.

stopImmediatePropagation():Void

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

stopPropagation():Void

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