Skip to content

Commit bb743c4

Browse files
perrin4869darrachequesne
authored andcommitted
[docs] Document connected and disconnected socket properties (#1155)
1 parent f31837f commit bb743c4

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

docs/API.md

+30
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@
3333
- [Event: 'pong'](#event-pong)
3434
- [Class: io.Socket](#socket)
3535
- [socket.id](#socketid)
36+
- [socket.connected](#socketconnected)
37+
- [socket.disconnected](#socketdisconnected)
3638
- [socket.open()](#socketopen)
3739
- [socket.connect()](#socketconnect)
3840
- [socket.send([...args][, ack])](#socketsendargs-ack)
@@ -396,6 +398,34 @@ socket.on('connect', () => {
396398
});
397399
```
398400

401+
#### socket.connected
402+
403+
- _(Boolean)_
404+
405+
Whether or not the socket is connected to the server.
406+
407+
```js
408+
const socket = io('http://localhost');
409+
410+
socket.on('connect', () => {
411+
console.log(socket.connected); // true
412+
});
413+
```
414+
415+
#### socket.disconnected
416+
417+
- _(Boolean)_
418+
419+
Whether or not the socket is disconnected from the server.
420+
421+
```js
422+
const socket = io('http://localhost');
423+
424+
socket.on('connect', () => {
425+
console.log(socket.disconnected); // false
426+
});
427+
```
428+
399429
#### socket.open()
400430

401431
- **Returns** `Socket`

0 commit comments

Comments
 (0)