fix(useWebSocket)!: rename type WebSocketOptions to `UseWebSocketOp…

…tions` and `WebSocketResult` to `UseWebSocketReturn` (#1895)
vueuse · Jul 13, 2022 · b461f3e · b461f3e
1 parent 7155053
commit b461f3e
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/packages/core/useWebSocket/index.ts b/packages/core/useWebSocket/index.ts
@@ -6,7 +6,7 @@ import { useEventListener } from '../useEventListener'
 
 export type WebSocketStatus = 'OPEN' | 'CONNECTING' | 'CLOSED'
 
-export interface WebSocketOptions {
+export interface UseWebSocketOptions {
   onConnected?: (ws: WebSocket) => void
   onDisconnected?: (ws: WebSocket, event: CloseEvent) => void
   onError?: (ws: WebSocket, event: Event) => void
@@ -83,7 +83,7 @@ export interface WebSocketOptions {
   protocols?: string[]
 }
 
-export interface WebSocketResult<T> {
+export interface UseWebSocketReturn<T> {
   /**
    * Reference to the latest data received via the websocket,
    * can be watched to respond to incoming messages
@@ -135,8 +135,8 @@ function resolveNestedOptions<T>(options: T | true): T {
  */
 export function useWebSocket<Data = any>(
   url: string,
-  options: WebSocketOptions = {},
-): WebSocketResult<Data> {
+  options: UseWebSocketOptions = {},
+): UseWebSocketReturn<Data> {
   const {
     onConnected,
     onDisconnected,