socket.io-client README

The project's README from github.com/socketio/socket.io-client. As one markdown file: README.md.

This repository and its history have been merged into the Socket.IO monorepo.

socket.io-client (socketio/socket.io-client)

Searching Database…

What is this?The official Socket.IO client: the browser and Node.js side of Socket.IO, a realtime application framework for exchanging events between clients and a server.
Is this the whole Socket.IO framework, or just one part of it?Just the client half — a JavaScript library that you embed in your own app to talk to a Socket.IO server, which is a separate part of the project.
How do I add it to a project?Install it from npm: npm install socket.io-client. Then point the client at your Socket.IO server's URL to open the connection.
Does the client work on its own, or do I need a server too?You need a Socket.IO server to connect to — it ships as its own package (socket.io) that runs on Node.js; without one the client has nothing to exchange events with.
Does it only run in the browser?No — it is built for JavaScript in the browser and for Node.js alike, so the same client code runs on a web page or inside a Node process.
Is Socket.IO free, and how mature is it?It is free and open source, and very mature: this client repository dates back to 2010 and has more than 10,000 stars on GitHub.
What do people build with it?Realtime features — chats, live notifications, dashboards and similar UIs where the server should push updates to connected clients instantly instead of the client polling.
Creator
socketio
Size
9.3 MB
Stars
10.6K
Age
16y
Commits · 90 Days