Skip to content

Commit 51c768e

Browse files
[docs] Explicitly document that Server extends EventEmitter (socketio#2874)
1 parent a3e5731 commit 51c768e

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/API.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@
4040
- [socket.send([...args][, ack])](#socketsendargs-ack)
4141
- [socket.emit(eventName[, ...args][, ack])](#socketemiteventname-args-ack)
4242
- [socket.on(eventName, callback)](#socketoneventname-callback)
43+
- [socket.once(eventName, listener)](#socketonceeventname-listener)
44+
- [socket.removeListener(eventName, listener)](#socketremovelistenereventname-listener)
45+
- [socket.removeAllListeners([eventName])](#socketremovealllistenerseventname)
46+
- [socket.eventNames()](#socketeventnames)
4347
- [socket.join(room[, callback])](#socketjoinroom-callback)
4448
- [socket.join(rooms[, callback])](#socketjoinrooms-callback)
4549
- [socket.leave(room[, callback])](#socketleaveroom-callback)
@@ -357,6 +361,8 @@ It should be noted the `Socket` doesn't relate directly to the actual underlying
357361

358362
Within each `Namespace`, you can also define arbitrary channels (called `room`) that the `Socket` can join and leave. That provides a convenient way to broadcast to a group of `Socket`s (see `Socket#to` below).
359363

364+
The `Socket` class inherits from [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter). The `Socket` class overrides the `emit` method, and does not modify any other `EventEmitter` method. All methods documented here which also appear as `EventEmitter` methods (apart from `emit`) are implemented by `EventEmitter`, and documentation for `EventEmitter` applies.
365+
360366
#### socket.id
361367

362368
* _(String)_
@@ -415,6 +421,7 @@ Sends a `message` event. See [socket.emit(eventName[, ...args][, ack])](#sockete
415421

416422
#### socket.emit(eventName[, ...args][, ack])
417423

424+
*(overrides `EventEmitter.emit`)*
418425
- `eventName` _(String)_
419426
- `args`
420427
- `ack` _(Function)_
@@ -448,6 +455,7 @@ io.on('connection', function(client){
448455

449456
#### socket.on(eventName, callback)
450457

458+
*(inherited from `EventEmitter`)*
451459
- `eventName` _(String)_
452460
- `callback` _(Function)_
453461
- **Returns** `Socket`
@@ -460,6 +468,13 @@ socket.on('news', function (data) {
460468
});
461469
```
462470

471+
#### socket.once(eventName, listener)
472+
#### socket.removeListener(eventName, listener)
473+
#### socket.removeAllListeners([eventName])
474+
#### socket.eventNames()
475+
476+
Inherited from `EventEmitter` (along with other methods not mentioned here). See Node.js documentation for the `events` module.
477+
463478
#### socket.join(room[, callback])
464479

465480
- `room` _(String)_

0 commit comments

Comments
 (0)