1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237# Socket.IO server for Deno
An implementation of the Socket.IO protocol for Deno.
Table of content:
- [Usage](#usage)
- [Options](#options)
- [`path`](#path)
- [`connectTimeout`](#connecttimeout)
- [`pingTimeout`](#pingtimeout)
- [`pingInterval`](#pinginterval)
- [`upgradeTimeout`](#upgradetimeout)
- [`maxHttpBufferSize`](#maxhttpbuffersize)
- [`allowRequest`](#allowrequest)
- [`cors`](#cors)
- [`editHandshakeHeaders`](#edithandshakeheaders)
- [`editResponseHeaders`](#editresponseheaders)
- [Logs](#logs)
## Usage
```ts
import { serve } from "https://deno.land/std@0.150.0/http/server.ts";
import { Server } from "https://deno.land/x/socket_io@0.1.0/mod.ts";
const io = new Server();
io.on("connection", (socket) => {
console.log(`socket ${socket.id} connected`);
socket.emit("hello", "world");
socket.on("disconnect", (reason) => {
console.log(`socket ${socket.id} disconnected due to ${reason}`);
});
});
await serve(io.handler(), {
port: 3000,
});
```
And then run with:
```
$ deno run --allow-net index.ts
```
Like the [Node.js server](https://socket.io/docs/v4/typescript/), you can also
provide types for the events sent between the server and the clients:
```ts
interface ServerToClientEvents {
noArg: () => void;
basicEmit: (a: number, b: string, c: Buffer) => void;
withAck: (d: string, callback: (e: number) => void) => void;
}
interface ClientToServerEvents {
hello: () => void;
}
interface InterServerEvents {
ping: () => void;
}
interface SocketData {
user_id: string;
}
const io = new Server<
ClientToServerEvents,
ServerToClientEvents,
InterServerEvents,
SocketData
>();
```
## Options
### `path`
Default value: `/socket.io/`
It is the name of the path that is captured on the server side.
Caution! The server and the client values must match (unless you are using a
path-rewriting proxy in between).
Example:
```ts
const io = new Server(httpServer, {
path: "/my-custom-path/",
});
```
### `connectTimeout`
Default value: `45000`
The number of ms before disconnecting a client that has not successfully joined
a namespace.
### `pingTimeout`
Default value: `20000`
This value is used in the heartbeat mechanism, which periodically checks if the
connection is still alive between the server and the client.
The server sends a ping, and if the client does not answer with a pong within
`pingTimeout` ms, the server considers that the connection is closed.
Similarly, if the client does not receive a ping from the server within
`pingInterval + pingTimeout` ms, the client also considers that the connection
is closed.
### `pingInterval`
Default value: `25000`
See [`pingTimeout`](#pingtimeout) for more explanation.
### `upgradeTimeout`
Default value: `10000`
This is the delay in milliseconds before an uncompleted transport upgrade is
cancelled.
### `maxHttpBufferSize`
Default value: `1e6` (1 MB)
This defines how many bytes a single message can be, before closing the socket.
You may increase or decrease this value depending on your needs.
### `allowRequest`
Default value: `-`
A function that receives a given handshake or upgrade request as its first
parameter, and can decide whether to continue or not.
Example:
```ts
const io = new Server({
allowRequest: (req, connInfo) => {
return Promise.reject("thou shall not pass");
},
});
```
### `cors`
Default value: `-`
A set of options related to
[Cross-Origin Resource Sharing](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
(CORS).
Example:
```ts
const io = new Server({
cors: {
origin: ["https://example.com"],
allowedHeaders: ["my-header"],
credentials: true,
},
});
```
### `editHandshakeHeaders`
Default value: `-`
A function that allows to edit the response headers of the handshake request.
Example:
```ts
const io = new Server({
editHandshakeHeaders: (responseHeaders, req, connInfo) => {
responseHeaders.set("set-cookie", "sid=1234");
},
});
```
### `editResponseHeaders`
Default value: `-`
A function that allows to edit the response headers of all requests.
Example:
```ts
const io = new Server({
editResponseHeaders: (responseHeaders, req, connInfo) => {
responseHeaders.set("my-header", "abcd");
},
});
```
## Logs
The library relies on the standard `log` module, so you can display the internal
logs of the Socket.IO server with:
```ts
import * as log from "https://deno.land/std@0.150.0/log/mod.ts";
await log.setup({
handlers: {
console: new log.handlers.ConsoleHandler("DEBUG"),
},
loggers: {
"socket.io": {
level: "DEBUG",
handlers: ["console"],
},
"engine.io": {
level: "DEBUG",
handlers: ["console"],
},
},
});
```
## License
[ISC](/LICENSE)