Socket

---

Import

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

Source

View the source code

Package

@hyper-fetch/sockets

Parameters

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;
}

Parameters

Name	Type	Description
options	SocketOptionsType<Adapter>

Properties

adapter

Source

View the source code

Type

Adapter

---

appManager

Source

View the source code

Type

AppManager

---

autoConnect

Source

View the source code

Type

boolean

---

debug

Source

View the source code

Type

boolean

---

emitter

Source

View the source code

Type

EventEmitter

---

events

Source

View the source code

Type

{ 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 }

---

logger

Source

View the source code

Type

LoggerMethods

---

loggerManager

Source

View the source code

Type

LoggerManager

---

options

Source

View the source code

Type

SocketOptionsType<Adapter>

---

reconnectAttempts

Source

View the source code

Type

number

---

reconnectTime

Source

View the source code

Type

number

---

unstable_onConnectedCallbacks

Source

View the source code

Type

OpenCallbackType[]

---

unstable_onDisconnectCallbacks

Source

View the source code

Type

CloseCallbackType[]

---

unstable_onErrorCallbacks

Source

View the source code

Type

ErrorCallbackType<any>[]

---

unstable_onMessageCallbacks

Source

View the source code

Type

MessageCallbackType<any>[]

---

unstable_onReconnectCallbacks

Source

View the source code

Type

ReconnectCallbackType[]

---

unstable_onReconnectFailedCallbacks

Source

View the source code

Type

ReconnectFailedCallbackType[]

---

unstable_onSendCallbacks

Source

View the source code

Type

SendCallbackType<EmitterInstance>[]

---

url

Source

View the source code

Type

string

---

Methods

connect()

This method connects the socket to the server

Source

View the source code

Preview

connect()

Returns

Promise<void>

---

createEmitter()

Create event emitter

Source

View the source code

Preview

createEmitter<Payload>()

Returns

<Endpoint>(options: EmitterOptionsType<Endpoint, Adapter>) => Emitter<Payload, Endpoint, Socket<Adapter>, false, false>

---

createListener()

Create event listener

Source

View the source code

Preview

createListener<Response>()

Returns

<Endpoint>(options: ListenerOptionsType<Endpoint, Adapter>) => Listener<Response, Endpoint, Socket<Adapter>, false>

---

disconnect()

This method disconnects the socket from the server

Source

View the source code

Preview

disconnect()

Returns

Promise<void>

---

onConnected()

Triggered when connection is opened

Source

View the source code

Preview

onConnected(callback: OpenCallbackType)

Parameters

Parameters

Name	Type	Description
callback	OpenCallbackType

Returns

Socket<Adapter>

---

onDisconnected()

Triggered when connection is closed

Source

View the source code

Preview

onDisconnected(callback: CloseCallbackType)

Parameters

Parameters

Name	Type	Description
callback	CloseCallbackType

Returns

Socket<Adapter>

---

onError()

Triggered when we receive error

Source

View the source code

Preview

onError<Event>(callback: ErrorCallbackType<Event>)

Parameters

Parameters

Name	Type	Description
callback	ErrorCallbackType<Event>

Returns

Socket<Adapter>

---

onMessage()

Triggered when any message is received

Source

View the source code

Preview

onMessage<Event>(callback: MessageCallbackType<Event>)

Parameters

Parameters

Name	Type	Description
callback	MessageCallbackType<Event>

Returns

Socket<Adapter>

---

onReconnect()

Triggered when connection is getting reconnected

Source

View the source code

Preview

onReconnect(callback: ReconnectCallbackType)

Parameters

Parameters

Name	Type	Description
callback	ReconnectCallbackType

Returns

Socket<Adapter>

---

onReconnectFailed()

Triggered when connection attempts are stopped

Source

View the source code

Preview

onReconnectFailed(callback: ReconnectFailedCallbackType)

Parameters

Parameters

Name	Type	Description
callback	ReconnectFailedCallbackType

Returns

Socket<Adapter>

---

onSend()

Triggered when any event is emitted

Source

View the source code

Preview

onSend(callback: SendCallbackType<EmitterInstance>)

Parameters

Parameters

Name	Type	Description
callback	SendCallbackType<EmitterInstance>

Returns

Socket<Adapter>

---

reconnect()

This method reconnect the socket to the server

Source

View the source code

Preview

reconnect()

Returns

Promise<void>

---

setDebug()

This method enables the logger usage and display the logs in console

Source

View the source code

Preview

setDebug(enabled: boolean)

Parameters

Parameters

Name	Type	Description
enabled	boolean

Returns

Socket<Adapter>

---

setLogLevel()

Set the logger severity of the messages displayed to the console

Source

View the source code

Preview

setLogLevel(level: LogLevel)

Parameters

Parameters

Name	Type	Description
level	LogLevel

Returns

Socket<Adapter>

---

setLogger()

Set the new logger instance to the socket

Source

View the source code

Preview

setLogger(callback: (socket: Socket<Adapter>) => LoggerManager)

Parameters

Parameters

Name	Type	Description
callback	(socket: Socket<Adapter>) => LoggerManager

Returns

Socket<Adapter>

---

setQueryParams()

Source

View the source code

Preview

setQueryParams(queryParams: ExtractAdapterQueryParamsType<Adapter>)

Parameters

Parameters

Name	Type	Description
queryParams	ExtractAdapterQueryParamsType<Adapter>

Returns

Socket<Adapter>

---

unstable__modifyResponse()

Source

View the source code

Preview

unstable__modifyResponse(data: { data: any; extra: ExtractAdapterExtraType<Adapter> })

Parameters

Parameters

Name	Type	Description
data	{ data: any; extra: ExtractAdapterExtraType<Adapter> }

Returns

unstable__modifyResponse

Name	Type	Description
data	any
extra	any

---

unstable__modifySend()

---

Interceptors

---

Source

View the source code

Preview

unstable__modifySend(emitter: EmitterInstance)

Parameters

Parameters

Name	Type	Description
emitter	EmitterInstance

Returns

EmitterInstance

---