298 lines
14 KiB
TypeScript
298 lines
14 KiB
TypeScript
/**
|
|
* 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](https://developer.mozilla.org/docs/Web/API/CloseEvent)
|
|
*/
|
|
interface CloseEvent extends Event {
|
|
/**
|
|
* Returns the WebSocket connection close code provided by the server.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/CloseEvent/code)
|
|
*/
|
|
readonly code: number;
|
|
/**
|
|
* Returns the WebSocket connection close reason provided by the server.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/CloseEvent/reason)
|
|
*/
|
|
readonly reason: string;
|
|
/**
|
|
* Returns true if the connection closed cleanly; false otherwise.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/CloseEvent/wasClean)
|
|
*/
|
|
readonly wasClean: boolean;
|
|
}
|
|
/**
|
|
* An event which takes place in the DOM.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event)
|
|
*/
|
|
interface Event {
|
|
/**
|
|
* 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](https://developer.mozilla.org/docs/Web/API/Event/bubbles)
|
|
*/
|
|
readonly bubbles: boolean;
|
|
/**
|
|
* @deprecated
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble)
|
|
*/
|
|
cancelBubble: 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](https://developer.mozilla.org/docs/Web/API/Event/cancelable)
|
|
*/
|
|
readonly cancelable: 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](https://developer.mozilla.org/docs/Web/API/Event/composed)
|
|
*/
|
|
readonly composed: boolean;
|
|
/**
|
|
* Returns the object whose event listener's callback is currently being invoked.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/currentTarget)
|
|
*/
|
|
readonly currentTarget: EventTarget | null;
|
|
/**
|
|
* Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/defaultPrevented)
|
|
*/
|
|
readonly defaultPrevented: boolean;
|
|
/**
|
|
* Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/eventPhase)
|
|
*/
|
|
readonly eventPhase: number;
|
|
/**
|
|
* Returns true if event was dispatched by the user agent, and false otherwise.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/isTrusted)
|
|
*/
|
|
readonly isTrusted: boolean;
|
|
/**
|
|
* @deprecated
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/returnValue)
|
|
*/
|
|
returnValue: boolean;
|
|
/**
|
|
* @deprecated
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/srcElement)
|
|
*/
|
|
readonly srcElement: EventTarget | null;
|
|
/**
|
|
* Returns the object to which event is dispatched (its target).
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/target)
|
|
*/
|
|
readonly target: EventTarget | null;
|
|
/**
|
|
* Returns the event's timestamp as the number of milliseconds measured relative to the time origin.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/timeStamp)
|
|
*/
|
|
readonly timeStamp: DOMHighResTimeStamp;
|
|
/**
|
|
* Returns the type of event, e.g. "click", "hashchange", or "submit".
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/type)
|
|
*/
|
|
readonly type: string;
|
|
/**
|
|
* 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](https://developer.mozilla.org/docs/Web/API/Event/composedPath)
|
|
*/
|
|
composedPath(): EventTarget[];
|
|
/**
|
|
* @deprecated
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/initEvent)
|
|
*/
|
|
initEvent(type: string, bubbles?: boolean, cancelable?: boolean): 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.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/preventDefault)
|
|
*/
|
|
preventDefault(): 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](https://developer.mozilla.org/docs/Web/API/Event/stopImmediatePropagation)
|
|
*/
|
|
stopImmediatePropagation(): void;
|
|
/**
|
|
* When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopPropagation)
|
|
*/
|
|
stopPropagation(): void;
|
|
readonly NONE: 0;
|
|
readonly CAPTURING_PHASE: 1;
|
|
readonly AT_TARGET: 2;
|
|
readonly BUBBLING_PHASE: 3;
|
|
}
|
|
/**
|
|
* EventTarget is a DOM interface implemented by objects that can receive events and may have listeners for them.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget)
|
|
*/
|
|
interface EventTarget {
|
|
/**
|
|
* Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
|
|
*
|
|
* The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
|
|
*
|
|
* When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
|
|
*
|
|
* When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
|
|
*
|
|
* When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
|
|
*
|
|
* If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
|
|
*
|
|
* The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)
|
|
*/
|
|
addEventListener(type: string, callback: EventListenerOrEventListenerObject | null, options?: AddEventListenerOptions | boolean): void;
|
|
/**
|
|
* Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)
|
|
*/
|
|
dispatchEvent(event: Event): boolean;
|
|
/**
|
|
* Removes the event listener in target's event listener list with the same type, callback, and options.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)
|
|
*/
|
|
removeEventListener(type: string, callback: EventListenerOrEventListenerObject | null, options?: EventListenerOptions | boolean): void;
|
|
}
|
|
/**
|
|
* A message received by a target object.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent)
|
|
*/
|
|
interface MessageEvent<T = any> extends Event {
|
|
/**
|
|
* Returns the data of the message.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/data)
|
|
*/
|
|
readonly data: T;
|
|
/**
|
|
* Returns the last event ID string, for server-sent events.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/lastEventId)
|
|
*/
|
|
readonly lastEventId: string;
|
|
/**
|
|
* Returns the origin of the message, for server-sent events and cross-document messaging.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/origin)
|
|
*/
|
|
readonly origin: string;
|
|
/**
|
|
* Returns the MessagePort array sent with the message, for cross-document messaging and channel messaging.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/ports)
|
|
*/
|
|
readonly ports: ReadonlyArray<MessagePort>;
|
|
/**
|
|
* Returns the WindowProxy of the source window, for cross-document messaging, and the MessagePort being attached, in the connect event fired at SharedWorkerGlobalScope objects.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/source)
|
|
*/
|
|
readonly source: MessageEventSource | null;
|
|
/** @deprecated */
|
|
initMessageEvent(type: string, bubbles?: boolean, cancelable?: boolean, data?: any, origin?: string, lastEventId?: string, source?: MessageEventSource | null, ports?: MessagePort[]): void;
|
|
}
|
|
/**
|
|
* Provides the API for creating and managing a WebSocket connection to a server, as well as for sending and receiving data on the connection.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket)
|
|
*/
|
|
interface WebSocket extends EventTarget {
|
|
/**
|
|
* Returns a string that indicates how binary data from the WebSocket object is exposed to scripts:
|
|
*
|
|
* Can be set, to change how binary data is returned. The default is "blob".
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/binaryType)
|
|
*/
|
|
binaryType: BinaryType | (string & {});
|
|
/**
|
|
* Returns the number of bytes of application data (UTF-8 text and binary data) that have been queued using send() but not yet been transmitted to the network.
|
|
*
|
|
* If the WebSocket connection is closed, this attribute's value will only increase with each call to the send() method. (The number does not reset to zero once the connection closes.)
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/bufferedAmount)
|
|
*/
|
|
readonly bufferedAmount: number;
|
|
/**
|
|
* Returns the extensions selected by the server, if any.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/extensions)
|
|
*/
|
|
readonly extensions: string;
|
|
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/close_event) */
|
|
onclose: ((this: WebSocket, ev: CloseEvent) => any) | null;
|
|
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/error_event) */
|
|
onerror: ((this: WebSocket, ev: Event) => any) | null;
|
|
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/message_event) */
|
|
onmessage: ((this: WebSocket, ev: MessageEvent) => any) | null;
|
|
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/open_event) */
|
|
onopen: ((this: WebSocket, ev: Event) => any) | null;
|
|
/**
|
|
* Returns the subprotocol selected by the server, if any. It can be used in conjunction with the array form of the constructor's second argument to perform subprotocol negotiation.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/protocol)
|
|
*/
|
|
readonly protocol: string;
|
|
/**
|
|
* Returns the state of the WebSocket object's connection. It can have the values described below.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/readyState)
|
|
*/
|
|
readonly readyState: number;
|
|
/**
|
|
* Returns the URL that was used to establish the WebSocket connection.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/url)
|
|
*/
|
|
readonly url: string;
|
|
/**
|
|
* Closes the WebSocket connection, optionally using code as the the WebSocket connection close code and reason as the the WebSocket connection close reason.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/close)
|
|
*/
|
|
close(code?: number, reason?: string): void;
|
|
/**
|
|
* Transmits data using the WebSocket connection. data can be a string, a Blob, an ArrayBuffer, or an ArrayBufferView.
|
|
*
|
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/send)
|
|
*/
|
|
send(data: string | ArrayBufferLike | Blob | ArrayBufferView): void;
|
|
readonly CONNECTING: 0;
|
|
readonly OPEN: 1;
|
|
readonly CLOSING: 2;
|
|
readonly CLOSED: 3;
|
|
addEventListener<K extends keyof WebSocketEventMap>(type: K, listener: (this: WebSocket, ev: WebSocketEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
|
|
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
|
|
removeEventListener<K extends keyof WebSocketEventMap>(type: K, listener: (this: WebSocket, ev: WebSocketEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
|
|
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
|
|
}
|
|
|
|
export type { CloseEvent as C, EventTarget as E, MessageEvent as M, WebSocket as W, Event as a };
|