SocketInstance

---

Import

import { SocketInstance } from "@hyper-fetch/sockets"

Source

View the source code

Package

@hyper-fetch/sockets

Preview

class Socket<Adapter> {
  constructor(options: SocketOptionsType<Adapter>) {};
  url: string;
  unstable_onSendCallbacks: SendCallbackType<EmitterInstance>[];
  unstable_onReconnectFailedCallbacks: ReconnectFailedCallbackType[];
  unstable_onReconnectCallbacks: ReconnectCallbackType[];
  unstable_onMessageCallbacks: MessageCallbackType<any>[];
  unstable_onErrorCallbacks: ErrorCallbackType<any>[];
  unstable_onDisconnectCallbacks: CloseCallbackType[];
  unstable_onConnectedCallbacks: OpenCallbackType[];
  reconnectTime: number;
  reconnectAttempts: number;
  options: SocketOptionsType<Adapter>;
  loggerManager: LoggerManager;
  logger: LoggerMethods;
  events: { emitConnected: () => void; emitConnecting: (__namedParameters: { connecting: boolean }) => void; emitDisconnected: () => void; emitEmitterError: <EmitterType>(__namedParameters: { emitter: EmitterType; error: Error }) => void; emitEmitterStartEvent: <EmitterType>(__namedParameters: { emitter: EmitterType }) => void; emitError: <ResponseType>(__namedParameters: { error: ResponseType }) => void; emitListenerEvent: <ResponseType>(__namedParameters: { data: ResponseType; extra: any; topic: string }) => void; emitListenerRemoveEvent: (__namedParameters: { topic: string }) => void; emitReconnecting: (__namedParameters: { attempts: number }) => void; emitReconnectingFailed: (__namedParameters: { attempts: number }) => void; onConnected: (callback: () => void) => VoidFunction; onConnecting: (callback: (__namedParameters: { connecting: boolean }) => void) => VoidFunction; onDisconnected: (callback: () => void) => VoidFunction; onEmitterError: <EmitterType>(callback: (__namedParameters: { emitter: EmitterType; error: Error }) => void) => VoidFunction; onEmitterErrorByTopic: <EmitterType>(emitter: Pick<EmitterType, topic>, callback: (__namedParameters: { emitter: EmitterType; error: Error }) => void) => VoidFunction; onEmitterStartEvent: <EmitterType>(callback: (__namedParameters: { emitter: EmitterType }) => void) => VoidFunction; onEmitterStartEventByTopic: <EmitterType>(emitter: Pick<EmitterType, topic>, callback: (__namedParameters: { emitter: EmitterType }) => void) => VoidFunction; onError: (callback: <ResponseType>(__namedParameters: { error: ResponseType }) => void) => VoidFunction; onListenerEvent: <ResponseType>(callback: (__namedParameters: { data: ResponseType; extra: any; topic: string }) => void) => VoidFunction; onListenerEventByTopic: <ListenerType>(listener: Pick<ListenerType, topic>, callback: (__namedParameters: { data: ResponseType; extra: any; topic: string }) => void) => VoidFunction; onListenerRemove: (callback: (__namedParameters: { topic: string }) => void) => VoidFunction; onListenerRemoveByTopic: <ListenerType>(listener: Pick<ListenerType, topic>, callback: (__namedParameters: { topic: string }) => void) => VoidFunction; onReconnecting: (callback: (__namedParameters: { attempts: number }) => void) => VoidFunction; onReconnectingFailed: (callback: (__namedParameters: { attempts: number }) => void) => VoidFunction };
  emitter: EventEmitter;
  debug: boolean;
  autoConnect: boolean;
  appManager: AppManager;
  adapter: Adapter;
  connect() => Promise<void>;
  createEmitter<Payload>() => <Endpoint>(options: EmitterOptionsType<Endpoint, Adapter>) => Emitter<Payload, Endpoint, Socket<Adapter>, false, false>;
  createListener<Response>() => <Endpoint>(options: ListenerOptionsType<Endpoint, Adapter>) => Listener<Response, Endpoint, Socket<Adapter>, false>;
  disconnect() => Promise<void>;
  onConnected(callback: OpenCallbackType) => Socket<Adapter>;
  onDisconnected(callback: CloseCallbackType) => Socket<Adapter>;
  onError<Event>(callback: ErrorCallbackType<Event>) => Socket<Adapter>;
  onMessage<Event>(callback: MessageCallbackType<Event>) => Socket<Adapter>;
  onReconnect(callback: ReconnectCallbackType) => Socket<Adapter>;
  onReconnectFailed(callback: ReconnectFailedCallbackType) => Socket<Adapter>;
  onSend(callback: SendCallbackType<EmitterInstance>) => Socket<Adapter>;
  reconnect() => Promise<void>;
  setDebug(enabled: boolean) => Socket<Adapter>;
  setLogLevel(level: LogLevel) => Socket<Adapter>;
  setLogger(callback: (socket: Socket<Adapter>) => LoggerManager) => Socket<Adapter>;
  setQueryParams(queryParams: ExtractAdapterQueryParamsType<Adapter>) => Socket<Adapter>;
  unstable__modifyResponse(data: { data: any; extra: ExtractAdapterExtraType<Adapter> }) => { data: any; extra: any };
  unstable__modifySend(emitter: EmitterInstance) => EmitterInstance;
}