Skip to content

Commit 47f917a

Browse files
david-fongdarrachequesne
authored andcommitted
fix(typings): add return types and general-case overload signatures (#1440)
1 parent f02ab3b commit 47f917a

File tree

3 files changed

+66
-52
lines changed

3 files changed

+66
-52
lines changed

lib/index.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ function lookup(
3232
uri: string,
3333
opts?: Partial<ManagerOptions & SocketOptions>
3434
): Socket;
35+
function lookup(
36+
uri: string | Partial<ManagerOptions & SocketOptions>,
37+
opts?: Partial<ManagerOptions & SocketOptions>
38+
): Socket;
3539
function lookup(
3640
uri: string | Partial<ManagerOptions & SocketOptions>,
3741
opts?: Partial<ManagerOptions & SocketOptions>

lib/manager.ts

Lines changed: 37 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,10 @@ export class Manager extends Emitter {
304304
*/
305305
constructor(opts: Partial<ManagerOptions>);
306306
constructor(uri?: string, opts?: Partial<ManagerOptions>);
307+
constructor(
308+
uri?: string | Partial<ManagerOptions>,
309+
opts?: Partial<ManagerOptions>
310+
);
307311
constructor(
308312
uri?: string | Partial<ManagerOptions>,
309313
opts?: Partial<ManagerOptions>
@@ -344,9 +348,10 @@ export class Manager extends Emitter {
344348
* @return {Manager} self or value
345349
* @public
346350
*/
347-
public reconnection(v: boolean): Manager;
351+
public reconnection(v: boolean): this;
348352
public reconnection(): boolean;
349-
public reconnection(v?: boolean): Manager | boolean {
353+
public reconnection(v?: boolean): this | boolean;
354+
public reconnection(v?: boolean): this | boolean {
350355
if (!arguments.length) return this._reconnection;
351356
this._reconnection = !!v;
352357
return this;
@@ -359,9 +364,10 @@ export class Manager extends Emitter {
359364
* @return {Manager} self or value
360365
* @public
361366
*/
362-
public reconnectionAttempts(v: number): Manager;
367+
public reconnectionAttempts(v: number): this;
363368
public reconnectionAttempts(): number;
364-
public reconnectionAttempts(v?: number): Manager | number {
369+
public reconnectionAttempts(v?: number): this | number;
370+
public reconnectionAttempts(v?: number): this | number {
365371
if (v === undefined) return this._reconnectionAttempts;
366372
this._reconnectionAttempts = v;
367373
return this;
@@ -374,9 +380,10 @@ export class Manager extends Emitter {
374380
* @return {Manager} self or value
375381
* @public
376382
*/
377-
public reconnectionDelay(v: number): Manager;
383+
public reconnectionDelay(v: number): this;
378384
public reconnectionDelay(): number;
379-
public reconnectionDelay(v?: number): Manager | number {
385+
public reconnectionDelay(v?: number): this | number;
386+
public reconnectionDelay(v?: number): this | number {
380387
if (v === undefined) return this._reconnectionDelay;
381388
this._reconnectionDelay = v;
382389
this.backoff?.setMin(v);
@@ -390,9 +397,10 @@ export class Manager extends Emitter {
390397
* @return self or value
391398
* @public
392399
*/
393-
public randomizationFactor(v: number): Manager;
400+
public randomizationFactor(v: number): this;
394401
public randomizationFactor(): number;
395-
public randomizationFactor(v?: number): Manager | number {
402+
public randomizationFactor(v?: number): this | number;
403+
public randomizationFactor(v?: number): this | number {
396404
if (v === undefined) return this._randomizationFactor;
397405
this._randomizationFactor = v;
398406
this.backoff?.setJitter(v);
@@ -406,9 +414,10 @@ export class Manager extends Emitter {
406414
* @return self or value
407415
* @public
408416
*/
409-
public reconnectionDelayMax(v: number): Manager;
417+
public reconnectionDelayMax(v: number): this;
410418
public reconnectionDelayMax(): number;
411-
public reconnectionDelayMax(v?: number): Manager | number {
419+
public reconnectionDelayMax(v?: number): this | number;
420+
public reconnectionDelayMax(v?: number): this | number {
412421
if (v === undefined) return this._reconnectionDelayMax;
413422
this._reconnectionDelayMax = v;
414423
this.backoff?.setMax(v);
@@ -422,9 +431,10 @@ export class Manager extends Emitter {
422431
* @return self or value
423432
* @public
424433
*/
425-
public timeout(v: number | boolean): Manager;
434+
public timeout(v: number | boolean): this;
426435
public timeout(): number | boolean;
427-
public timeout(v?: number | boolean): Manager | number | boolean {
436+
public timeout(v?: number | boolean): this | number | boolean;
437+
public timeout(v?: number | boolean): this | number | boolean {
428438
if (!arguments.length) return this._timeout;
429439
this._timeout = v;
430440
return this;
@@ -455,7 +465,7 @@ export class Manager extends Emitter {
455465
* @return self
456466
* @public
457467
*/
458-
public open(fn?: (err?: Error) => void): Manager {
468+
public open(fn?: (err?: Error) => void): this {
459469
debug("readyState %s", this._readyState);
460470
if (~this._readyState.indexOf("open")) return this;
461471

@@ -519,7 +529,7 @@ export class Manager extends Emitter {
519529
* @return self
520530
* @public
521531
*/
522-
public connect(fn?: (err?: Error) => void): Manager {
532+
public connect(fn?: (err?: Error) => void): this {
523533
return this.open(fn);
524534
}
525535

@@ -528,7 +538,7 @@ export class Manager extends Emitter {
528538
*
529539
* @private
530540
*/
531-
private onopen() {
541+
private onopen(): void {
532542
debug("open");
533543

534544
// clear old subs
@@ -554,7 +564,7 @@ export class Manager extends Emitter {
554564
*
555565
* @private
556566
*/
557-
private onping() {
567+
private onping(): void {
558568
super.emit("ping");
559569
}
560570

@@ -563,7 +573,7 @@ export class Manager extends Emitter {
563573
*
564574
* @private
565575
*/
566-
private ondata(data) {
576+
private ondata(data): void {
567577
this.decoder.add(data);
568578
}
569579

@@ -572,7 +582,7 @@ export class Manager extends Emitter {
572582
*
573583
* @private
574584
*/
575-
private ondecoded(packet) {
585+
private ondecoded(packet): void {
576586
super.emit("packet", packet);
577587
}
578588

@@ -581,7 +591,7 @@ export class Manager extends Emitter {
581591
*
582592
* @private
583593
*/
584-
private onerror(err) {
594+
private onerror(err): void {
585595
debug("error", err);
586596
super.emit("error", err);
587597
}
@@ -608,7 +618,7 @@ export class Manager extends Emitter {
608618
* @param socket
609619
* @private
610620
*/
611-
_destroy(socket: Socket) {
621+
_destroy(socket: Socket): void {
612622
const nsps = Object.keys(this.nsps);
613623

614624
for (const nsp of nsps) {
@@ -629,7 +639,7 @@ export class Manager extends Emitter {
629639
* @param packet
630640
* @private
631641
*/
632-
_packet(packet: Partial<Packet & { query: string; options: any }>) {
642+
_packet(packet: Partial<Packet & { query: string; options: any }>): void {
633643
debug("writing packet %j", packet);
634644

635645
const encodedPackets = this.encoder.encode(packet as Packet);
@@ -643,7 +653,7 @@ export class Manager extends Emitter {
643653
*
644654
* @private
645655
*/
646-
private cleanup() {
656+
private cleanup(): void {
647657
debug("cleanup");
648658

649659
this.subs.forEach((subDestroy) => subDestroy());
@@ -657,7 +667,7 @@ export class Manager extends Emitter {
657667
*
658668
* @private
659669
*/
660-
_close() {
670+
_close(): void {
661671
debug("disconnect");
662672
this.skipReconnect = true;
663673
this._reconnecting = false;
@@ -676,7 +686,7 @@ export class Manager extends Emitter {
676686
*
677687
* @private
678688
*/
679-
private disconnect() {
689+
private disconnect(): void {
680690
return this._close();
681691
}
682692

@@ -685,7 +695,7 @@ export class Manager extends Emitter {
685695
*
686696
* @private
687697
*/
688-
private onclose(reason: string) {
698+
private onclose(reason: string): void {
689699
debug("onclose");
690700

691701
this.cleanup();
@@ -703,7 +713,7 @@ export class Manager extends Emitter {
703713
*
704714
* @private
705715
*/
706-
private reconnect() {
716+
private reconnect(): this | void {
707717
if (this._reconnecting || this.skipReconnect) return this;
708718

709719
const self = this;
@@ -751,7 +761,7 @@ export class Manager extends Emitter {
751761
*
752762
* @private
753763
*/
754-
private onreconnect() {
764+
private onreconnect(): void {
755765
const attempt = this.backoff.attempts;
756766
this._reconnecting = false;
757767
this.backoff.reset();

0 commit comments

Comments
 (0)