WebSocketStream: метод close()

Экспериментально: Это экспериментальная технология experimental technology
Внимательно проверьте таблицу совместимости браузеров, прежде чем использовать её в продакшене.

Примечание: Эта функция доступна в Web Workers.

Метод close() интерфейса WebSocketStream закрывает соединение WebSocket. Метод необязательно принимает объект, содержащий пользовательский код и/или причину закрытия соединения.

Альтернативный механизм закрытия WebSocketStream — это указание AbortSignal в опции signal конструктора при создании. Соответствующий AbortController затем может быть использован для закрытия соединения WebSocket. Это, как правило, предпочтительный механизм. Однако, close() может быть использован, если вы хотите указать пользовательский код и/или причину.

Синтаксис

close()
close(options)

Параметры

options Необязательно

Объект опций, содержащий следующие свойства:

closeCode Необязательно: Число, представляющее код закрытия (см. полный список CloseEvent кодов статуса).
reason Необязательно: Строка, представляющая удобочитаемое описание причины закрытия сокета. Максимальная длина reason строки составляет 123 байта. Строка автоматически кодируется в UTF-8 при вызове функции.

Примечание: В зависимости от конфигурации сервера и используемого кода статуса сервер может игнорировать пользовательский код в пользу корректного кода, соответствующего причине закрытия. Допустимыми кодами являются 1000 и любые коды в диапазоне от 3000 до 4999 включительно.

Возвращаемое значение

Ничего (undefined).

Исключения

SyntaxError DOMException: Выбрасывается, если предоставленная reason длиннее максимальной допустимой длины в 123 байта.

Примеры

const wsURL = "wss://127.0.0.1/";
const wss = new WebSocketStream(wsURL);

setTimeout(() => {
  wss.close({
    code: 1000,
    reason: "That's all folks",
  });
}, 10000);

Спецификации

В настоящее время не является частью какой-либо спецификации. Смотрите https://github.com/whatwg/websockets/pull/48 для информации о ходе стандартизации.

Совместимость с браузерами

	Рабочие столы					Мобильные устройства
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox для Android	Opera Android	Safari на iOS	Samsung Internet	WebView Android
`close`	124	124	Нет	110	Нет	124	Нет	82	Нет	27.0	124

См. также

WebSocketStream: интеграция потоков с API WebSocket, developer.chrome.com (2020)

© 2005–2024 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/WebSocketStream/close