@gwakko/shared-websocket 0.1.0

package/dist/adapters/vue.d.ts

@@ -0,0 +1,53 @@
+import { type Ref, type InjectionKey, type App } from 'vue';
+import { SharedWebSocket } from '../SharedWebSocket';
+import type { SharedWebSocketOptions, TabRole } from '../types';
+export declare const SharedWebSocketKey: InjectionKey<SharedWebSocket>;
+/**
+ * Vue 3 plugin for SharedWebSocket.
+ *
+ * @example
+ * const app = createApp(App);
+ * app.use(createSharedWebSocketPlugin('wss://api.example.com/ws'));
+ */
+export declare function createSharedWebSocketPlugin(url: string, options?: SharedWebSocketOptions): {
+    install(app: App): void;
+};
+/**
+ * Access the SharedWebSocket instance from provided context.
+ *
+ * @example
+ * const ws = useSharedWebSocket();
+ */
+export declare function useSharedWebSocket(): SharedWebSocket;
+/**
+ * Subscribe to a WebSocket event. Returns reactive ref with latest value.
+ *
+ * @example
+ * const order = useSocketEvent<Order>('order.created');
+ */
+export declare function useSocketEvent<T>(event: string): Ref<T | undefined>;
+/**
+ * Accumulate WebSocket events into reactive array.
+ *
+ * @example
+ * const messages = useSocketStream<ChatMessage>('chat.message');
+ */
+export declare function useSocketStream<T>(event: string): Ref<T[]>;
+/**
+ * Two-way state sync across browser tabs via reactive ref.
+ *
+ * @example
+ * const cart = useSocketSync<Cart>('cart', { items: [] });
+ * cart.value = { items: [1, 2, 3] }; // syncs to all tabs
+ */
+export declare function useSocketSync<T>(key: string, initialValue: T): Ref<T>;
+/**
+ * Reactive connection status.
+ *
+ * @example
+ * const { connected, tabRole } = useSocketStatus();
+ */
+export declare function useSocketStatus(): {
+    connected: Ref<boolean>;
+    tabRole: Ref<TabRole>;
+};