Установка клиента

Совместимость

Socket.IO поддерживает IE9 и выше. IE 6/7/8 больше не поддерживаются.

Совместимость с браузерами тестируется благодаря замечательной платформе Sauce Labs:

Заметки к выпуску

Заметки к каждому выпуску можно найти на GitHub.

Установка

Автономный сборка

По умолчанию сервер Socket.IO предоставляет пакет клиента по адресу /socket.io/socket.io.js.

io будет зарегистрирован как глобальная переменная:

<script src="/socket.io/socket.io.js"></script>
<script>
  const socket = io();
</script>

Если вам это не нужно (смотрите другие варианты ниже), вы можете отключить эту функциональность на стороне сервера:

const io = require("socket.io")({
  serveClient: false
});

Из CDN

Вы также можете включить пакет клиента из CDN:

<script src="https://cdn.socket.io/3.1.1/socket.io.min.js" integrity="sha384-gDaozqUvc4HTgo8iZjwth73C6dDDeOJsAgpxBcMpZYztUfjHXpzrpdrHRdVp8ySO" crossorigin="anonymous"></script>

Socket.IO также доступен из других CDN:

• cdnjs: https://cdnjs.cloudflare.com/ajax/libs/socket.io/3.1.1/socket.io.min.js
• jsDelivr: https://cdn.jsdelivr.net/npm/socket.io-client@3.1.1/dist/socket.io.min.js
• unpkg: https://unpkg.com/socket.io-client@3.1.1/dist/socket.io.min.js

Доступно несколько пакетов:

Пакет debug позволяет выводить отладочную информацию в консоль. Дополнительную информацию можно найти здесь.

Во время разработки рекомендуется использовать пакет socket.io.js. Установив localStorage.debug = 'socket.io-client:socket', любое событие, полученное клиентом, будет выведено в консоль.

Для производства используйте пакет socket.io.min.js, который является оптимизированной сборкой без пакета debug.

Из NPM

Клиент Socket.IO совместим с такими сборщиками, как webpack или browserify.

$ npm install socket.io-client

Клиент также может быть запущен из Node.js.

Примечание: по причинам, указанным выше, вы можете исключить debug из вашего пакета для браузера. С помощью webpack вы можете использовать webpack-remove-debug.

Примечание для пользователей TypeScript: типы теперь включены в пакет socket.io-client, а типы из @types/socket.io-client больше не нужны и могут, фактически, вызывать ошибки:

Object literal may only specify known properties, and 'extraHeaders' does not exist in type 'ConnectOpts'