Skip to main content
Version: v8.0.0

getAdapterBindings


Import
import { getAdapterBindings } from "@hyper-fetch/sockets"

Parameters​

getAdapterBindings<T>(socket: Socket<T>)
Parameters
NameTypeDescription
socket
Socket<T>

Returns​

getAdapterBindings
NameTypeDescription
adapter
T
logger
LoggerMethods
socket
Socket<T>
getQueryParams
(queryParams: undefined | ExtractAdapterQueryParamsType<T>) => any
onConnect
() => Promise<null | SocketConnectionType<T>>
onConnectFailed
(__namedParameters: { error: Error }) => void
onConnected
() => void
onDisconnect
() => boolean
onDisconnected
() => void
onEmit
(__namedParameters: { emitter: EmitterInstance }) => Promise<null | EmitterInstance>
onEmitError
<ErrorType>(__namedParameters: { emitter: EmitterInstance; error: ErrorType }) => void
onError
(__namedParameters: { error: Error }) => void
onEvent
(__namedParameters: { data: any; extra: ExtractAdapterExtraType<T>; topic: string }) => void
onListen
(__namedParameters: { callback: ListenerCallbackType<T, any>; listener: Pick<ListenerOfAdapter<T>, topic>; onUnmount?: VoidFunction }) => () => void
onReconnect
(__namedParameters: { connect: () => Promise<any>; disconnect: () => Promise<any> }) => Promise<boolean>