Skip to content

chore(engine.io): fix comment formatting inconsistencies in socket.ts #5420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore(engine.io): fix comment formatting inconsistencies in socket.ts #5420

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions packages/engine.io/lib/socket.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,16 +89,16 @@ export class Socket extends EventEmitter {
this.request = req;
this.protocol = protocol;

// Cache IP since it might not be in the req later
// Cache IP since it might not be in the request later
if (req) {
if (req.websocket && req.websocket._socket) {
this.remoteAddress = req.websocket._socket.remoteAddress;
} else {
this.remoteAddress = req.connection.remoteAddress;
}
} else {
// TODO there is currently no way to get the IP address of the client when it connects with WebTransport
// see https://github.com/fails-components/webtransport/issues/114
// TODO: There is currently no way to get the IP address of the client when it connects with WebTransport.
// See https://github.com/fails-components/webtransport/issues/114
}

this.pingTimeoutTimer = null;
Expand Down Expand Up @@ -195,7 +195,7 @@ export class Socket extends EventEmitter {
/**
* Called upon transport error.
*
* @param {Error} err - error object
* @param {Error} err - The error object.
* @private
*/
private onError(err: Error) {
Expand Down Expand Up @@ -268,7 +268,7 @@ export class Socket extends EventEmitter {
}

/**
* Upon transport "drain" event
* Upon transport "drain" event.
*
* @private
*/
Expand Down Expand Up @@ -337,7 +337,7 @@ export class Socket extends EventEmitter {
}
};

// we force a polling cycle to ensure a fast upgrade
// We force a polling cycle to ensure a fast upgrade.
const check = () => {
if ("polling" === this.transport.name && this.transport.writable) {
debug("writing a noop packet to polling for fast upgrade");
Expand Down Expand Up @@ -394,12 +394,12 @@ export class Socket extends EventEmitter {
cleanup();
}

// silence further transport errors and prevent uncaught exceptions
// silence further transport errors and prevent uncaught exceptions.
this.transport.on("error", function () {
debug("error triggered by discarded transport");
});

// ensure transport won't stay open
// ensure transport won't stay open.
this.transport.close();

clearTimeout(this.pingTimeoutTimer);
Expand All @@ -414,12 +414,12 @@ export class Socket extends EventEmitter {
if ("closed" !== this.readyState) {
this.readyState = "closed";

// clear timers
// Clear timers.
clearTimeout(this.pingIntervalTimer);
clearTimeout(this.pingTimeoutTimer);

// clean writeBuffer in next tick, so developers can still
// grab the writeBuffer on 'close' event
// Clean writeBuffer in next tick, so developers can still
// grab the writeBuffer on the "close" event.
process.nextTick(() => {
this.writeBuffer = [];
});
Expand Down Expand Up @@ -489,7 +489,7 @@ export class Socket extends EventEmitter {

if (data) packet.data = data;

// exports packetCreate event
// Export packetCreate event.
this.emit("packetCreate", packet);

this.writeBuffer.push(packet);
Expand Down