Interface SocketOptions

packages/engine.io-client/lib/socket.ts:41–261

}

export interface SocketOptions {
  /**
   * The host that we're connecting to. Set from the URI passed when connecting
   */
  host?: string;

  /**
   * The hostname for our connection. Set from the URI passed when connecting
   */
  hostname?: string;

  /**
   * If this is a secure connection. Set from the URI passed when connecting
   */
  secure?: boolean;

  /**
   * The port for our connection. Set from the URI passed when connecting
   */
  port?: string | number;

  /**
   * Any query parameters in our uri. Set from the URI passed when connecting
   */
  query?: { [key: string]: any };

  /**
   * `http.Agent` to use, defaults to `false` (NodeJS only)
   *
   * Note: the type should be "undefined | http.Agent | https.Agent | false", but this would break browser-only clients.
   *
   * @see https://nodejs.org/api/http.html#httprequestoptions-callback
   */
  agent?: string | boolean;

  /**
   * Whether the client should try to upgrade the transport from
   * long-polling to something better.
   * @default true
   */
  upgrade?: boolean;

  /**
   * Forces base 64 encoding for polling transport even when XHR2
   * responseType is available and WebSocket even if the used standard
   * supports binary.
   */
  forceBase64?: boolean;

  /**
   * The param name to use as our timestamp key
   * @default 't'
   */
  timestampParam?: string;

  /**
   * Whether to add the timestamp with each transport request. Note: this
   * is ignored if the browser is IE or Android, in which case requests