Interface CloseEvent

    A CloseEvent is sent to clients using WebSockets when the connection is closed. This is delivered to the listener indicated by the WebSocket object's onclose attribute.

    MDN Reference

    interface CloseEvent {
        AT_TARGET: 2;
        bubbles: boolean;
        BUBBLING_PHASE: 3;
        cancelable: boolean;
        cancelBubble: boolean;
        CAPTURING_PHASE: 1;
        code: number;
        composed: boolean;
        currentTarget: EventTarget;
        defaultPrevented: boolean;
        eventPhase: number;
        isTrusted: boolean;
        NONE: 0;
        reason: string;
        returnValue: boolean;
        srcElement: EventTarget;
        target: EventTarget;
        timeStamp: number;
        type: string;
        wasClean: boolean;
        composedPath(): EventTarget[];
        initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
        preventDefault(): void;
        stopImmediatePropagation(): void;
        stopPropagation(): void;
    }
    Hierarchy

    Properties

    AT_TARGET: 2
    bubbles: boolean

    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.

    MDN Reference

    BUBBLING_PHASE: 3
    cancelable: boolean

    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.

    MDN Reference

    cancelBubble: boolean

    MDN Reference

    CAPTURING_PHASE: 1
    code: number

    Returns the WebSocket connection close code provided by the server.

    MDN Reference

    composed: boolean

    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.

    MDN Reference

    currentTarget: EventTarget

    Returns the object whose event listener's callback is currently being invoked.

    MDN Reference

    defaultPrevented: boolean

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

    MDN Reference

    eventPhase: number

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

    MDN Reference

    isTrusted: boolean

    Returns true if event was dispatched by the user agent, and false otherwise.

    MDN Reference

    NONE: 0
    reason: string

    Returns the WebSocket connection close reason provided by the server.

    MDN Reference

    returnValue: boolean

    MDN Reference

    srcElement: EventTarget

    MDN Reference

    target: EventTarget

    Returns the object to which event is dispatched (its target).

    MDN Reference

    timeStamp: number

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

    MDN Reference

    type: string

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

    MDN Reference

    wasClean: boolean

    Returns true if the connection closed cleanly; false otherwise.

    MDN Reference

    Methods

    • 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.

      MDN Reference

      Returns EventTarget[]

    • Parameters

      • type: string
      • Optionalbubbles: boolean
      • Optionalcancelable: boolean

      Returns void

      MDN Reference

    • 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.

      MDN Reference

      Returns void

    • 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.

      MDN Reference

      Returns void

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

      MDN Reference

      Returns void