Skip to content

Commit

Permalink
docs(examples): add example with ES modules
Browse files Browse the repository at this point in the history
  • Loading branch information
darrachequesne committed Oct 15, 2020
1 parent 0ce5b4c commit 20ea6bd
Show file tree
Hide file tree
Showing 5 changed files with 304 additions and 0 deletions.
17 changes: 17 additions & 0 deletions examples/es-modules/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@

# Example with [ES modules](https://nodejs.org/api/esm.html)

## How to use

```
# install the dependencies
$ npm ci
# start the server
$ node server.js
# start the client
$ node client.js
```

You need Node.js `>=12.17.0`.
18 changes: 18 additions & 0 deletions examples/es-modules/client.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { Manager } from "socket.io-client";

const manager = new Manager("ws://localhost:8080");
const socket = manager.socket("/");

socket.on("connect", () => {
console.log(`connect ${socket.id}`);
});

socket.on("disconnect", () => {
console.log(`disconnect`);
});

setInterval(() => {
socket.emit("ping", () => {
console.log("pong");
});
}, 1000);
238 changes: 238 additions & 0 deletions examples/es-modules/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 15 additions & 0 deletions examples/es-modules/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"name": "es-modules",
"version": "1.0.0",
"description": "An example with ES modules (https://nodejs.org/api/esm.html)",
"type": "module",
"author": "Damien Arrachequesne",
"license": "MIT",
"engines": {
"node": ">=12.17.0"
},
"dependencies": {
"socket.io": "beta",
"socket.io-client": "beta"
}
}
16 changes: 16 additions & 0 deletions examples/es-modules/server.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import { Server } from "socket.io";

const io = new Server(8080);

io.on("connect", (socket) => {
console.log(`connect ${socket.id}`);

socket.on("ping", (cb) => {
console.log("ping");
cb();
});

socket.on("disconnect", () => {
console.log(`disconnect ${socket.id}`);
});
});

0 comments on commit 20ea6bd

Please sign in to comment.