feat: add webSocketFactory option to RealTimeDataClient
#24
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds a
webSocketFactoryoption toRealTimeDataClientArgs, allowingcallers to fully control how WebSocket instances are created.
This is useful for:
ws,undici, testing mocks)Key Changes
WebSocketFactorytype andwebSocketFactoryoptional parameter.connect()now uses this factory instead of constructing WebSockets directly.new WebSocket(...)via isomorphic-ws.??instead of||for correctness).Benefits
This makes the client substantially more flexible and easier to integrate into
production environments where proxying, observability, or custom network stacks
are required.
No behavioral changes for existing users.
Note
Adds an optional
webSocketFactorytoRealTimeDataClientand uses it inconnect()with a backward-compatible default.src/client.ts):WebSocketFactorytype and optionalwebSocketFactoryinRealTimeDataClientArgs.connect()instead ofnew WebSocket(...).host => new WebSocket(host)) to preserve behavior.??defaults and default args (constructor(args: RealTimeDataClientArgs = {})).Written by Cursor Bugbot for commit f14e327. This will update automatically on new commits. Configure here.