feat(useWebSocket): allow undefined ref for url (#2473)

* feat(useWebSocket): allow undefined ref for url * docs(useWebSocket): update outdated type declarations
vueuse · Jan 29, 2023 · 1392410 · 1392410
1 parent 902b3cc
commit 1392410
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/packages/core/useWebSocket/index.md b/packages/core/useWebSocket/index.md
@@ -174,7 +174,7 @@ export interface WebSocketResult<T> {
  * @param url
  */
 export declare function useWebSocket<Data = any>(
-  url: string,
+  url: MaybeComputedRef<string | URL | undefined>,
   options?: WebSocketOptions
 ): WebSocketResult<Data>
 ```

diff --git a/packages/core/useWebSocket/index.ts b/packages/core/useWebSocket/index.ts
@@ -143,7 +143,7 @@ function resolveNestedOptions<T>(options: T | true): T {
  * @param url
  */
 export function useWebSocket<Data = any>(
-  url: MaybeComputedRef<string | URL>,
+  url: MaybeComputedRef<string | URL | undefined>,
   options: UseWebSocketOptions = {},
 ): UseWebSocketReturn<Data> {
   const {
@@ -205,7 +205,7 @@ export function useWebSocket<Data = any>(
   }
 
   const _init = () => {
-    if (explicitlyClosed)
+    if (explicitlyClosed || typeof urlRef.value === 'undefined')
       return
 
     const ws = new WebSocket(urlRef.value, protocols)