getSocketEvents

---

Import

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

Source

View the source code

Package

@hyper-fetch/sockets

Parameters

getSocketEvents<Adapter>(eventEmitter: EventEmitter)

Parameters

Name	Type	Description
eventEmitter	EventEmitter

Returns

getSocketEvents

Name	Type	Description
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: ExtractAdapterExtraType<Adapter>; 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: ExtractAdapterExtraType<Adapter>; topic: string }) => void) => VoidFunction
onListenerEventByTopic	<ListenerType>(listener: Pick<ListenerType, topic>, callback: (__namedParameters: { data: ResponseType; extra: ExtractAdapterExtraType<Adapter>; 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