Chartbreaker
    Preparing search index...

    Interface CloseEvent_2

    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.

    interface CloseEvent_2 {
        AT_TARGET: number;
        bubbles: boolean;
        BUBBLING_PHASE: number;
        cancelable: boolean;
        cancelBubble: boolean;
        CAPTURING_PHASE: number;
        code: number;
        composed: boolean;
        defaultPrevented: boolean;
        eventPhase: number;
        isTrusted: boolean;
        NONE: number;
        reason: string;
        returnValue: boolean;
        timeStamp: number;
        type: string;
        wasClean: boolean;
        initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
        preventDefault(): void;
        stopImmediatePropagation(): void;
        stopPropagation(): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    AT_TARGET: number
    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.

    BUBBLING_PHASE: number
    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.

    cancelBubble: boolean
    CAPTURING_PHASE: number
    code: number

    Returns the WebSocket connection close code provided by the server.

    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.

    defaultPrevented: boolean

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

    eventPhase: number

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

    isTrusted: boolean

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

    NONE: number
    reason: string

    Returns the WebSocket connection close reason provided by the server.

    returnValue: boolean
    timeStamp: number

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

    type: string

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

    wasClean: boolean

    Returns true if the connection closed cleanly; false otherwise.

    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.

      Parameters

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

      Returns void

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

      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.

      Returns void

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

      Returns void