@choewy/react-socket
Version:
React Socket.io
21 lines (20 loc) • 1.67 kB
TypeScript
import { Socket } from 'socket.io-client';
import { SocketClientOptions, SocketConnectErrorHandler, SocketConnectionHandler, SocketDisconnectHandler, SocketErrorHandler, SocketEventHandler, SocketReconnectAttemptHandler, SocketReconnectErrorHandler, SocketReconnectFailedHandler, SocketReconnectHandler } from './interfaces';
export declare class SocketClient {
private readonly name;
private _socket;
constructor({ name, url, namespace, ...opts }: SocketClientOptions);
get emit(): <Ev extends string>(ev: Ev, ...args: any[]) => Socket<import("@socket.io/component-emitter").DefaultEventsMap, import("@socket.io/component-emitter").DefaultEventsMap>;
get emitWithAck(): <Ev extends string>(ev: Ev, ...args: any[]) => Promise<any>;
get disconnect(): () => Socket<import("@socket.io/component-emitter").DefaultEventsMap, import("@socket.io/component-emitter").DefaultEventsMap>;
useConnect(): void;
useOnEvent(event: 'connect', handler: SocketConnectionHandler): void;
useOnEvent(event: 'connect_error', handler: SocketConnectErrorHandler): void;
useOnEvent(event: 'disconnect', handler: SocketDisconnectHandler): void;
useOnEvent(event: 'error', handler: SocketErrorHandler): void;
useOnEvent(event: 'reconnect', handler: SocketReconnectHandler): void;
useOnEvent(event: 'reconnect_attempt', handler: SocketReconnectAttemptHandler): void;
useOnEvent(event: 'reconnect_error', handler: SocketReconnectErrorHandler): void;
useOnEvent(event: 'reconnect_failed', handler: SocketReconnectFailedHandler): void;
useOnEvent<T extends Array<unknown> = []>(event: string, handler: SocketEventHandler<T>): void;
}