global.WebSocket — Kuito Documentação

Utilização

Keep a connection open

tsx

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 }) => {};

Construtores

(url: string | URL, protocols?: string | string[]): WebSocket

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`url`	`string \| URL`	Sim	—
`protocols`	`string \| string[]`	Não	—

Devolve

WebSocket

Propriedades e métodos 19

Nome	Tipo	Obrigatório	Descrição
`prototype`só de leitura	`WebSocket`	Sim	—
`CONNECTING`só de leitura	`0`	Sim	—
`OPEN`só de leitura	`1`	Sim	—
`CLOSING`só de leitura	`2`	Sim	—
`CLOSED`só de leitura	`3`	Sim	—
`url`só de leitura	`string`	Sim	—
`readyState`só de leitura	`0 \| 2 \| 1 \| 3`	Sim	—
`protocol`só de leitura	`string`	Sim	The subprotocol the server chose, once open.
`bufferedAmount`só de leitura	`number`	Sim	Always 0: bytes are not counted on their way out.
`extensions`só de leitura	`string`	Sim	—
`binaryType`	`"arraybuffer"`	Sim	Only 'arraybuffer': there is no Blob.
`onopen`	`(event: WebSocketEvent) => void`	Sim	—
`onmessage`	`(event: WebSocketEvent) => void`	Sim	—
`onerror`	`(event: WebSocketEvent) => void`	Sim	—
`onclose`	`(event: WebSocketEvent) => void`	Sim	—
`addEventListener`	`(type: WebSocketEvent["type"], listener: (event: WebSocketEvent) => void) => void`	Sim	—
`removeEventListener`	`(type: WebSocketEvent["type"], listener: (event: WebSocketEvent) => void) => void`	Sim	—
`send`	`(data: string \| ArrayBuffer \| ArrayBufferView) => void`	Sim	—
`close`	`(code?: number, reason?: string) => void`	Sim	—

onopen — assinaturas de método

Assinaturas

(event: WebSocketEvent): void

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`event`	`WebSocketEvent`	Sim	—

Devolve

void

onmessage — assinaturas de método

Assinaturas

(event: WebSocketEvent): void

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`event`	`WebSocketEvent`	Sim	—

Devolve

void

onerror — assinaturas de método

Assinaturas

(event: WebSocketEvent): void

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`event`	`WebSocketEvent`	Sim	—

Devolve

void

onclose — assinaturas de método

Assinaturas

(event: WebSocketEvent): void

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`event`	`WebSocketEvent`	Sim	—

Devolve

void

addEventListener — assinaturas de método

Assinaturas

(type: WebSocketEvent["type"], listener: (event: WebSocketEvent) => void): void

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`type`	`"close" \| "open" \| "error" \| "message"`	Sim	—
`listener`	`(event: WebSocketEvent) => void`	Sim	—

Devolve

void

removeEventListener — assinaturas de método

Assinaturas

(type: WebSocketEvent["type"], listener: (event: WebSocketEvent) => void): void

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`type`	`"close" \| "open" \| "error" \| "message"`	Sim	—
`listener`	`(event: WebSocketEvent) => void`	Sim	—

Devolve

void

send — assinaturas de método

Assinaturas

(data: string | ArrayBuffer | ArrayBufferView): void

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`data`	`string \| ArrayBuffer \| ArrayBufferView<ArrayBufferLike>`	Sim	—

Devolve

void

close — assinaturas de método

Assinaturas

(code?: number, reason?: string): void

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`code`	`number`	Não	—
`reason`	`string`	Não	—

Devolve

void

Gerado a partir das declarações TypeScript públicas: assinaturas, props e predefinições vêm da fonte verificada, as descrições da sua JSDoc. Nenhuma predefinição é inventada.