partysocket
Version:
A better WebSocket that Just Works™
31 lines (29 loc) • 967 B
TypeScript
import {
a as ProtocolsProvider,
i as Options,
o as ReconnectingWebSocket,
s as UrlProvider
} from "./ws-Cg2f-sDL.js";
//#region src/use-handlers.d.ts
type EventHandlerOptions = {
onOpen?: (event: WebSocketEventMap["open"]) => void;
onMessage?: (event: WebSocketEventMap["message"]) => void;
onClose?: (event: WebSocketEventMap["close"]) => void;
onError?: (event: WebSocketEventMap["error"]) => void;
};
//#endregion
//#region src/use-socket.d.ts
type SocketOptions = Options & {
/** Whether the socket should be connected. Defaults to true. */ enabled?: boolean;
};
//#endregion
//#region src/use-ws.d.ts
type UseWebSocketOptions = SocketOptions & EventHandlerOptions;
declare function useWebSocket(
url: UrlProvider,
protocols?: ProtocolsProvider,
options?: UseWebSocketOptions
): ReconnectingWebSocket;
//#endregion
export { SocketOptions as n, EventHandlerOptions as r, useWebSocket as t };
//# sourceMappingURL=use-ws-C42-rZBy.d.ts.map