rename transportimpl

Author: darrachequesne

packages/engine.io/lib/server.ts

@@ -21,14 +21,14 @@ import type { CorsOptions, CorsOptionsDelegate } from "cors";
 import type { Duplex } from "stream";
 import { WebTransport } from "./transports/webtransport";
 import { createPacketDecoderStream } from "engine.io-parser";
-import type { EngineRequest, Transport as TransportImpl } from "./transport";
+import type { EngineRequest, Transport } from "./transport";
 import type { CookieSerializeOptions } from "./contrib/types.cookie";
 
 const debug = debugModule("engine");
 
 const kResponseHeaders = Symbol("responseHeaders");
 
-type Transport = "polling" | "websocket" | "webtransport";
+type TransportName = "polling" | "websocket" | "webtransport";
 
 export type ErrorCallback = (
   errorCode?: (typeof Server.errors)[keyof typeof Server.errors],
@@ -100,7 +100,7 @@ export interface ServerOptions {
    *
    * @default ["polling", "websocket"]
    */
-  transports?: Transport[];
+  transports?: TransportName[];
   /**
    * whether to allow transport upgrades
    * @default true
@@ -255,7 +255,7 @@ export abstract class BaseServer extends EventEmitter {
   /**
    * Returns a list of available transports for upgrade given a certain transport.
    */
-  public upgrades(transport: Transport): string[] {
+  public upgrades(transport: TransportName): string[] {
     if (!this.opts.allowUpgrades) return [];
     return transports[transport].upgradesTo || [];
   }
@@ -278,7 +278,7 @@ export abstract class BaseServer extends EventEmitter {
     const transport = req._query.transport;
     // WebTransport does not go through the verify() method, see the onWebTransportSession() method
     if (
-      !~this.opts.transports.indexOf(transport as Transport) ||
+      !~this.opts.transports.indexOf(transport as TransportName) ||
       transport === "webtransport"
     ) {
       debug('unknown transport "%s"', transport);
@@ -431,7 +431,7 @@ export abstract class BaseServer extends EventEmitter {
    * @protected
    */
   protected async handshake(
-    transportName: string,
+    transportName: TransportName,
     req: EngineRequest,
     closeConnection: ErrorCallback,
   ) {
@@ -472,7 +472,7 @@ export abstract class BaseServer extends EventEmitter {
     debug('handshaking client "%s"', id);
 
     try {
-      var transport = this.createTransport(transportName as Transport, req);
+      var transport = this.createTransport(transportName, req);
       if ("polling" === transportName) {
         transport.maxHttpBufferSize = this.opts.maxHttpBufferSize;
         transport.httpCompression = this.opts.httpCompression;
@@ -610,7 +610,7 @@ export abstract class BaseServer extends EventEmitter {
   }
 
   protected abstract createTransport(
-    transportName: Transport,
+    transportName: TransportName,
     req: EngineRequest,
   );
 
@@ -742,7 +742,7 @@ export class Server extends BaseServer {
     }
   }
 
-  protected createTransport(transportName: Transport, req: IncomingMessage) {
+  protected createTransport(transportName: TransportName, req: IncomingMessage): Transport {
     // @ts-expect-error 'polling' is a plain function used as constructor
     return new transports[transportName](req);
   }
@@ -776,7 +776,7 @@ export class Server extends BaseServer {
       } else {
         const closeConnection = (errorCode, errorContext) =>
           abortRequest(res, errorCode, errorContext);
-        this.handshake(req._query.transport, req, closeConnection);
+        this.handshake(req._query.transport as TransportName, req, closeConnection);
       }
     };
 
@@ -880,8 +880,8 @@ export class Server extends BaseServer {
         // transport error handling takes over
         websocket.removeListener("error", onUpgradeError);
 
-        const transport: TransportImpl = this.createTransport(
-          req._query.transport as Transport,
+        const transport = this.createTransport(
+          req._query.transport as TransportName,
           req,
         );
         // @ts-expect-error this option is only for WebSocket impl
@@ -891,7 +891,7 @@ export class Server extends BaseServer {
     } else {
       const closeConnection = (errorCode, errorContext) =>
         abortUpgrade(socket, errorCode, errorContext);
-      this.handshake(req._query.transport, req, closeConnection);
+      this.handshake(req._query.transport as TransportName, req, closeConnection);
     }
 
     function onUpgradeError() {