Pr/basic websocket#64
Open
alexeyslynko wants to merge 3 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Adds a basic WebSocket endpoint to
@type-r/endpoints.The implementation provides collection live updates through
subscribe()/unsubscribe()and keeps REST operations separate. Multiple collections using the same WebSocket URL, constructor, and protocols share one WebSocket connection, while each collection still sends its own subscribe/unsubscribe messages.Included
websocketIO(url, options?)for basic collection live updatesrestfulWebsocketIO(url, websocketUrl, options?)combiningrestfulIOCRUD/list with WebSocket live updatesupdated/removedlive update messages{ updated }and{ removed }Basic Options
WebSocketEndpointOptionsintentionally stays small:WebSocketprotocolsmatchsubscribeMessageunsubscribeMessageThe basic endpoint uses JSON messages only. It does not include reconnect, heartbeat, subscribe acknowledgements, cursors, replay, resync, or custom message encoding.
Testing
rollup --configinendpointspassedtscwas not runnable in the local workspace with the current TypeScript 6 setup because the old branch has existing unrelated type/config incompatibilities