From 535b068670848f6a3193528582484826a858d680 Mon Sep 17 00:00:00 2001 From: Damien Arrachequesne Date: Tue, 14 Feb 2023 15:25:57 +0100 Subject: [PATCH] docs: add upgrade event in the documentation Reference: https://github.com/socketio/engine.io/blob/898bd1c9df379f4749989afe82c311b7ed9c6174/lib/socket.ts#L285 Related: https://github.com/socketio/socket.io-website/issues/369 --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index da038e19..f33f788f 100644 --- a/README.md +++ b/README.md @@ -338,6 +338,14 @@ A representation of a client. _Inherits from EventEmitter_. - Fired when an error occurs. - **Arguments** - `Error`: error object +- `upgrading` + - Fired when the client starts the upgrade to a better transport like WebSocket. + - **Arguments** + - `Object`: the transport +- `upgrade` + - Fired when the client completes the upgrade to a better transport like WebSocket. + - **Arguments** + - `Object`: the transport - `flush` - Called when the write buffer is being flushed. - **Arguments**