Skip to content

Commit 6d87a40

Browse files
refactor: add types to socket.send()
Related: #645
1 parent 3d28229 commit 6d87a40

File tree

1 file changed

+24
-7
lines changed

1 file changed

+24
-7
lines changed

lib/socket.ts

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export class Socket extends EventEmitter {
2020
private upgrading: boolean;
2121
private upgraded: boolean;
2222
private writeBuffer: Packet[];
23-
private packetsFn: any[];
23+
private packetsFn: Array<() => void>;
2424
private sentCallbackFn: any[];
2525
private cleanupFn: any[];
2626
private checkIntervalTimer;
@@ -431,12 +431,27 @@ export class Socket extends EventEmitter {
431431
* @return {Socket} for chaining
432432
* @api public
433433
*/
434-
public send(data, options, callback?) {
434+
public send(
435+
data: RawData,
436+
options?: { compress: boolean },
437+
callback?: () => void
438+
) {
435439
this.sendPacket("message", data, options, callback);
436440
return this;
437441
}
438442

439-
public write(data, options, callback?) {
443+
/**
444+
* Alias of {@link send}.
445+
*
446+
* @param data
447+
* @param options
448+
* @param callback
449+
*/
450+
public write(
451+
data: RawData,
452+
options?: { compress: boolean },
453+
callback?: () => void
454+
) {
440455
this.sendPacket("message", data, options, callback);
441456
return this;
442457
}
@@ -451,15 +466,17 @@ export class Socket extends EventEmitter {
451466
*
452467
* @api private
453468
*/
454-
private sendPacket(type: PacketType, data?: RawData, options?, callback?) {
469+
private sendPacket(
470+
type: PacketType,
471+
data?: RawData,
472+
options: { compress: boolean } = { compress: true },
473+
callback?: () => void
474+
) {
455475
if ("function" === typeof options) {
456476
callback = options;
457477
options = null;
458478
}
459479

460-
options = options || {};
461-
options.compress = false !== options.compress;
462-
463480
if ("closing" !== this.readyState && "closed" !== this.readyState) {
464481
debug('sending packet "%s" (%s)', type, data);
465482

0 commit comments

Comments
 (0)