global.WebSocket
A WebSocket connection, for messages a server pushes to the app as they happen.
Usage
Keep a connection open
const socket = new WebSocket('wss://chat.example.com', ['v2']);
socket.onopen = () => socket.send(JSON.stringify({ hello: true }));
socket.onmessage = ({ data }) => console.log(data); // a string, or an ArrayBuffer
socket.onclose = ({ code, reason, wasClean }) => {};Constructors
(url: string | URL, protocols?: string | string[]): WebSocketParameters
| Name | Type | Required | Description |
|---|---|---|---|
url | string | URL | Yes | — |
protocols | string | string[] | No | — |
Returns
WebSocket
Properties and methods 19
| Name | Type | Required | Description |
|---|---|---|---|
prototypereadonly | WebSocket | Yes | — |
CONNECTINGreadonly | 0 | Yes | — |
OPENreadonly | 1 | Yes | — |
CLOSINGreadonly | 2 | Yes | — |
CLOSEDreadonly | 3 | Yes | — |
urlreadonly | string | Yes | — |
readyStatereadonly | 0 | 2 | 1 | 3 | Yes | — |
protocolreadonly | string | Yes | The subprotocol the server chose, once open. |
bufferedAmountreadonly | number | Yes | Always 0: bytes are not counted on their way out. |
extensionsreadonly | string | Yes | — |
binaryType | "arraybuffer" | Yes | Only 'arraybuffer': there is no Blob. |
onopen | (event: WebSocketEvent) => void | Yes | — |
onmessage | (event: WebSocketEvent) => void | Yes | — |
onerror | (event: WebSocketEvent) => void | Yes | — |
onclose | (event: WebSocketEvent) => void | Yes | — |
addEventListener | (type: WebSocketEvent["type"], listener: (event: WebSocketEvent) => void) => void | Yes | — |
removeEventListener | (type: WebSocketEvent["type"], listener: (event: WebSocketEvent) => void) => void | Yes | — |
send | (data: string | ArrayBuffer | ArrayBufferView) => void | Yes | — |
close | (code?: number, reason?: string) => void | Yes | — |
onopen — method signatures
Signatures
(event: WebSocketEvent): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
event | WebSocketEvent | Yes | — |
Returns
void
onmessage — method signatures
Signatures
(event: WebSocketEvent): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
event | WebSocketEvent | Yes | — |
Returns
void
onerror — method signatures
Signatures
(event: WebSocketEvent): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
event | WebSocketEvent | Yes | — |
Returns
void
onclose — method signatures
Signatures
(event: WebSocketEvent): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
event | WebSocketEvent | Yes | — |
Returns
void
addEventListener — method signatures
Signatures
(type: WebSocketEvent["type"], listener: (event: WebSocketEvent) => void): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
type | "close" | "open" | "error" | "message" | Yes | — |
listener | (event: WebSocketEvent) => void | Yes | — |
Returns
void
removeEventListener — method signatures
Signatures
(type: WebSocketEvent["type"], listener: (event: WebSocketEvent) => void): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
type | "close" | "open" | "error" | "message" | Yes | — |
listener | (event: WebSocketEvent) => void | Yes | — |
Returns
void
send — method signatures
Signatures
(data: string | ArrayBuffer | ArrayBufferView): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
data | string | ArrayBuffer | ArrayBufferView<ArrayBufferLike> | Yes | — |
Returns
void
close — method signatures
Signatures
(code?: number, reason?: string): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
code | number | No | — |
reason | string | No | — |
Returns
void
Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.