docs: use "connection" instead of "connect"

"connect" and "connection" have the same meaning, but "connection" is the preferred version.
socketio · Aug 12, 2023 · fd9dd74 · fd9dd74
1 parent c332643
commit fd9dd74
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -855,7 +855,7 @@ new Server(3000, {
 const socket = io("/admin");
 
 // server-side
-io.on("connect", socket => {
+io.on("connection", socket => {
   // not triggered anymore
 })
 
@@ -1006,7 +1006,7 @@ new Server(3000, {
 const socket = io("/admin");
 
 // server-side
-io.on("connect", socket => {
+io.on("connection", socket => {
   // not triggered anymore
 })
 

diff --git a/examples/angular-todomvc/server.ts b/examples/angular-todomvc/server.ts
@@ -15,7 +15,7 @@ interface Todo {
 
 let todos: Array<Todo> = [];
 
-io.on("connect", (socket) => {
+io.on("connection", (socket) => {
     socket.emit("todos", todos);
 
     // note: we could also create a CRUD (create/read/update/delete) service for the todo list

diff --git a/examples/es-modules/server.js b/examples/es-modules/server.js
@@ -2,7 +2,7 @@ import { Server } from "socket.io";
 
 const io = new Server(8080);
 
-io.on("connect", (socket) => {
+io.on("connection", (socket) => {
   console.log(`connect ${socket.id}`);
 
   socket.on("ping", (cb) => {

diff --git a/examples/express-session-example/index.js b/examples/express-session-example/index.js
@@ -67,7 +67,7 @@ io.engine.on("initial_headers", (headers, req) => {
   }
 });
 
-io.on("connect", (socket) => {
+io.on("connection", (socket) => {
   const req = socket.request;
 
   socket.join(req.session.id);

diff --git a/examples/typescript/server.ts b/examples/typescript/server.ts
@@ -2,7 +2,7 @@ import { Server } from "socket.io";
 
 const io = new Server(8080);
 
-io.on("connect", (socket) => {
+io.on("connection", (socket) => {
     console.log(`connect ${socket.id}`);
 
     socket.on("ping", (cb) => {

diff --git a/test/namespaces.ts b/test/namespaces.ts
@@ -62,7 +62,7 @@ describe("namespaces", () => {
     const io = new Server(0);
     const clientSocket = createClient(io);
 
-    io.on("connect", (socket) => {
+    io.on("connection", (socket) => {
       expect(socket).to.be.a(Socket);
       success(done, io, clientSocket);
     });

diff --git a/test/socket.io.test-d.ts b/test/socket.io.test-d.ts
@@ -24,7 +24,7 @@ describe("server", () => {
               expectType<DisconnectReason>(reason);
             });
           });
-          sio.on("connect", (s) => {
+          sio.on("connection", (s) => {
             expectType<Socket<DefaultEventsMap, DefaultEventsMap>>(s);
           });
           done();