Version: v8.0.0

SocketAdapter

Import

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

Source

View the source code

Package

@hyper-fetch/sockets

Parameters

class SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType> {
  constructor(options: { defaultConnected?: boolean; defaultConnecting?: boolean; defaultForceClosed?: boolean; defaultReconnectionAttempts?: number; name: string; queryParams?: QueryParams }) {};
  unstable_queryParamsMapperConfig: Parameters<QueryParamsMapperType>[1];
  unstable_queryParamsMapper: QueryParamsMapperType;
  socket: SocketInstance;
  reconnectionAttempts: number;
  queryParamsConfig: QueryStringifyOptionsType;
  queryParams: QueryParams;
  options: { defaultConnected?: boolean; defaultConnecting?: boolean; defaultForceClosed?: boolean; defaultReconnectionAttempts?: number; name: string; queryParams?: QueryParams };
  name: string;
  listeners: Map<string, Map<ListenerCallbackType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>, any>, VoidFunction>>;
  listenerOptions: ListenerOptions | EmptyTypes;
  forceClosed: boolean;
  emitterOptions: EmitterOptions | EmptyTypes;
  defaultExtra: Extra;
  connecting: boolean;
  connected: boolean;
  adapterOptions: AdapterOptions | EmptyTypes;
  connect() => () => void;
  disconnect() => () => void;
  emit() => (emitter: EmitterInstance) => void;
  listen() => (listener: ListenerOfAdapter<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>>, callback: ListenerCallbackType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>, any>) => RemoveListenerCallbackType;
  reconnect() => () => void;
  initialize(socket: SocketInstance) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>;
  removeListener(__namedParameters: { callback: ListenerCallbackType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>, any>; topic: string }) => boolean;
  setConnected(connected: boolean) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>;
  setConnecting(connecting: boolean) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>;
  setConnector(connector: (bindings: { adapter: SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>; getQueryParams: (queryParams: undefined | QueryParams) => any; logger: LoggerMethods; onConnect: () => Promise<null | SocketConnectionType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>>>; 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: Extra; topic: string }) => void; onListen: (__namedParameters: { callback: ListenerCallbackType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>, any>; listener: Pick<ListenerOfAdapter<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>>, topic>; onUnmount?: VoidFunction }) => () => void; onReconnect: (__namedParameters: { connect: () => Promise<any>; disconnect: () => Promise<any> }) => Promise<boolean>; socket: Socket<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>> }) => Connector<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>>) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>;
  setDefaultEmitterOptions(emitterOptions: EmitterOptions | EmptyTypes) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>;
  setDefaultExtra(defaultExtra: Extra) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>;
  setDefaultListenerOptions(listenerOptions: ListenerOptions | EmptyTypes) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>;
  setForceClosed(forceClosed: boolean) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>;
  setOptions(adapterOptions: AdapterOptions | EmptyTypes) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>;
  setQueryParams(queryParams: QueryParams) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>;
  setQueryParamsConfig(queryParamsConfig: QueryStringifyOptionsType) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>;
  setQueryParamsMapper<NewQueryParamsMapper>(queryParamsMapper: NewQueryParamsMapper) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, NewQueryParamsMapper>;
  setQueryParamsMapperConfig<NewQueryParamsMapperConfig>(config: NewQueryParamsMapperConfig) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>;
  setReconnectionAttempts(reconnectionAttempts: number) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>;
  triggerListeners(__namedParameters: { data: any; extra: Extra; topic: string }) => void;
}

Parameters

Name	Type	Description
options	`{ defaultConnected?: boolean; defaultConnecting?: boolean; defaultForceClosed?: boolean; defaultReconnectionAttempts?: number; name: string; queryParams?: QueryParams }`

Properties

adapterOptions

Source

View the source code

Type

AdapterOptions | EmptyTypes

connected

Source

View the source code

Type

boolean

connecting

Source

View the source code

Type

boolean

defaultExtra

Source

View the source code

Type

Extra

emitterOptions

Source

View the source code

Type

EmitterOptions | EmptyTypes

forceClosed

Source

View the source code

Type

boolean

listenerOptions

Source

View the source code

Type

ListenerOptions | EmptyTypes

listeners

Source

View the source code

Type

Map<string, Map<ListenerCallbackType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>, any>, VoidFunction>>

name

Source

View the source code

Type

string

options

Source

View the source code

Type

{ defaultConnected?: boolean; defaultConnecting?: boolean; defaultForceClosed?: boolean; defaultReconnectionAttempts?: number; name: string; queryParams?: QueryParams }

queryParams

Source

View the source code

Type

QueryParams

queryParamsConfig

Source

View the source code

Type

QueryStringifyOptionsType

reconnectionAttempts

Source

View the source code

Type

number

socket

Source

View the source code

Type

SocketInstance

unstable_queryParamsMapper

Method to get request data and transform them to the required format.

Source

View the source code

Type

QueryParamsMapperType

unstable_queryParamsMapperConfig

Config for the query params mapper

Source

View the source code

Type

Parameters<QueryParamsMapperType>[1]

Methods

initialize()

Source

View the source code

Preview

initialize(socket: SocketInstance)

Parameters

Name	Type	Description
socket	`SocketInstance`

Returns

SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>

removeListener()

Source

View the source code

Preview

removeListener(__namedParameters: { callback: ListenerCallbackType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>, any>; topic: string })

Parameters

Name	Type	Description
__namedParameters	`{ callback: ListenerCallbackType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>, any>; topic: string }`

Returns

boolean

setConnected()

Source

View the source code

Preview

setConnected(connected: boolean)

Parameters

Name	Type	Description
connected	`boolean`

Returns

SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>

setConnecting()

Source

View the source code

Preview

setConnecting(connecting: boolean)

Parameters

Name	Type	Description
connecting	`boolean`

Returns

SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>

setConnector()

Source

View the source code

Preview

setConnector(connector: (bindings: { adapter: SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>; getQueryParams: (queryParams: undefined | QueryParams) => any; logger: LoggerMethods; onConnect: () => Promise<null | SocketConnectionType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>>>; 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: Extra; topic: string }) => void; onListen: (__namedParameters: { callback: ListenerCallbackType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>, any>; listener: Pick<ListenerOfAdapter<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>>, topic>; onUnmount?: VoidFunction }) => () => void; onReconnect: (__namedParameters: { connect: () => Promise<any>; disconnect: () => Promise<any> }) => Promise<boolean>; socket: Socket<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>> }) => Connector<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>>)

Parameters

Name Type Description

connector

Name	Type	Description
connector	(bindings: { adapter: SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>; getQueryParams: (queryParams: undefined \| QueryParams) => any; logger: LoggerMethods; onConnect: () => Promise<null \| SocketConnectionType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>>>; 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: Extra; topic: string }) => void; onListen: (__namedParameters: { callback: ListenerCallbackType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>, any>; listener: Pick<ListenerOfAdapter<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>>, topic>; onUnmount?: VoidFunction }) => () => void; onReconnect: (__namedParameters: { connect: () => Promise<any>; disconnect: () => Promise<any> }) => Promise<boolean>; socket: Socket<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>> }) => Connector<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>>

(bindings: { adapter: SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>; getQueryParams: (queryParams: undefined | QueryParams) => any; logger: LoggerMethods; onConnect: () => Promise<null | SocketConnectionType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>>>; 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: Extra; topic: string }) => void; onListen: (__namedParameters: { callback: ListenerCallbackType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>, any>; listener: Pick<ListenerOfAdapter<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>>, topic>; onUnmount?: VoidFunction }) => () => void; onReconnect: (__namedParameters: { connect: () => Promise<any>; disconnect: () => Promise<any> }) => Promise<boolean>; socket: Socket<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>> }) => Connector<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>>

Returns

SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>

setDefaultEmitterOptions()

Source

View the source code

Preview

setDefaultEmitterOptions(emitterOptions: EmitterOptions | EmptyTypes)

Parameters

Name	Type	Description
emitterOptions	`EmitterOptions \| EmptyTypes`

Returns

SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>

setDefaultExtra()

Source

View the source code

Preview

setDefaultExtra(defaultExtra: Extra)

Parameters

Name	Type	Description
defaultExtra	`Extra`

Returns

SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>

setDefaultListenerOptions()

Source

View the source code

Preview

setDefaultListenerOptions(listenerOptions: ListenerOptions | EmptyTypes)

Parameters

Name	Type	Description
listenerOptions	`ListenerOptions \| EmptyTypes`

Returns

SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>

setForceClosed()

Source

View the source code

Preview

setForceClosed(forceClosed: boolean)

Parameters

Name	Type	Description
forceClosed	`boolean`

Returns

SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>

setOptions()

Source

View the source code

Preview

setOptions(adapterOptions: AdapterOptions | EmptyTypes)

Parameters

Name	Type	Description
adapterOptions	`AdapterOptions \| EmptyTypes`

Returns

SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>

setQueryParams()

Source

View the source code

Preview

setQueryParams(queryParams: QueryParams)

Parameters

Name	Type	Description
queryParams	`QueryParams`

Returns

SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>

setQueryParamsConfig()

Source

View the source code

Preview

setQueryParamsConfig(queryParamsConfig: QueryStringifyOptionsType)

Parameters

Name	Type	Description
queryParamsConfig	`QueryStringifyOptionsType`

Returns

SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>

setQueryParamsMapper()

Set the query params mapping function which get triggered before request get sent

Source

View the source code

Preview

setQueryParamsMapper<NewQueryParamsMapper>(queryParamsMapper: NewQueryParamsMapper)

Parameters

Name	Type	Description
queryParamsMapper	`NewQueryParamsMapper`

Returns

SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, NewQueryParamsMapper>

setQueryParamsMapperConfig()

Source

View the source code

Preview

setQueryParamsMapperConfig<NewQueryParamsMapperConfig>(config: NewQueryParamsMapperConfig)

Parameters

Name	Type	Description
config	`NewQueryParamsMapperConfig`

Returns

SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>

setReconnectionAttempts()

Source

View the source code

Preview

setReconnectionAttempts(reconnectionAttempts: number)

Parameters

Name	Type	Description
reconnectionAttempts	`number`

Returns

SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType>

triggerListeners()

Source

View the source code

Preview

triggerListeners(__namedParameters: { data: any; extra: Extra; topic: string })

Parameters

Name	Type	Description
__namedParameters	`{ data: any; extra: Extra; topic: string }`

Returns

void

Parameters​

Properties​

adapterOptions​

Type

connected​

Type

connecting​

Type

defaultExtra​

Type

emitterOptions​

Type

forceClosed​

Type

listenerOptions​

Type

listeners​

Type

name​

Type

options​

Type

queryParams​

Type

queryParamsConfig​

Type

reconnectionAttempts​

Type

socket​

Type

unstable_queryParamsMapper​

Type

unstable_queryParamsMapperConfig​

Type

Methods​

initialize()​

Preview

Parameters

Returns

removeListener()​

Preview

Parameters

Returns

setConnected()​

Preview

Parameters

Returns

setConnecting()​

Preview

Parameters

Returns

setConnector()​

Preview

Parameters

Returns

setDefaultEmitterOptions()​

Preview

Parameters

Returns

setDefaultExtra()​

Preview

Parameters

Returns

setDefaultListenerOptions()​

Preview

Parameters

Returns

setForceClosed()​

Preview

Parameters

Returns

setOptions()​

Preview

Parameters

Returns

setQueryParams()​

Preview

Parameters

Returns

setQueryParamsConfig()​

Parameters

Properties

adapterOptions

connected

connecting

defaultExtra

emitterOptions

forceClosed

listenerOptions

listeners

name

options

queryParams

queryParamsConfig

reconnectionAttempts

socket

unstable_queryParamsMapper

unstable_queryParamsMapperConfig

Methods

initialize()

removeListener()

setConnected()

setConnecting()

setConnector()

setDefaultEmitterOptions()

setDefaultExtra()

setDefaultListenerOptions()

setForceClosed()

setOptions()

setQueryParams()

setQueryParamsConfig()

setQueryParamsMapper()

setQueryParamsMapperConfig()

setReconnectionAttempts()

triggerListeners()