refactor: remove unused onlyBinaryUpgrades option

This option no longer has any effect since [1].

[1]: c46611ce44
This commit is contained in:
Damien Arrachequesne
2024-05-19 19:16:55 +02:00
parent 62cbed729d
commit 156d622c48
2 changed files with 0 additions and 7 deletions

View File

@@ -255,8 +255,6 @@ Exposed as `eio` in the browser standalone build.
(see [ws module](https://github.com/einaros/ws) api docs). Set to `false` to disable. (`true`)
- `threshold` (`Number`): data is compressed only if the byte size is above this value. This option is ignored on the browser. (`1024`)
- `extraHeaders` (`Object`): Headers that will be passed for each request to the server (via xhr-polling and via websockets). These values then can be used during handshake or for special proxies. Can only be used in Node.js client environment.
- `onlyBinaryUpgrades` (`Boolean`): whether transport upgrades should be restricted to transports supporting binary data (`false`)
- `forceNode` (`Boolean`): Uses NodeJS implementation for websockets - even if there is a native Browser-Websocket available, which is preferred by default over the NodeJS implementation. (This is useful when using hybrid platforms like nw.js or electron) (`false`, NodeJS only)
- `localAddress` (`String`): the local IP address to connect to
- `autoUnref` (`Boolean`): whether the transport should be `unref`'d upon creation. This calls `unref` on the underlying timers and sockets so that the program is allowed to exit if they are the only timers/sockets in the event system (Node.js only)
- `useNativeTimers` (`Boolean`): Whether to always use the native timeouts. This allows the client to reconnect when the native timeout functions are overridden, such as when mock clocks are installed with [`@sinonjs/fake-timers`](https://github.com/sinonjs/fake-timers).

View File

@@ -94,11 +94,6 @@ export interface SocketOptions {
*/
rememberUpgrade: boolean;
/**
* Are we only interested in transports that support binary?
*/
onlyBinaryUpgrades: boolean;
/**
* Timeout for xhr-polling requests in milliseconds (0) (only for polling transport)
*/