feat(useWebSocket): allow undefined ref for url #2473
Merged
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.
Description
I want to have a a global WebSocket in my app. Since the introduction of ref passing to useWebSocket, useWebSocket is much more useful for scenarios where you change between servers, since I can always expect the WebSocket to work and be up to date without any manual handling from our side. Everything works thanks to vue
computed
(to construct the webSocket url) and a ref to an object which contains the server URL.However, expecting only URLs or strings makes it really difficult to have that webSocket always globally: there are situations in my app where no server is defined. Without this PR, I need to have a watcher and then instantiate the socket using
useWebSocket
. This PR solves all this logic.Additional context
I also fixed the docs, which were with outdated types
What is the purpose of this pull request?
Before submitting the PR, please make sure you do the following
ref
, so my proposed solution for this make it much simpler for this kind of scenarios.fixes #123
).