ServerSentEventsAdapterType

---

Websocket

---

Import

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

Source

View the source code

Package

@hyper-fetch/sockets

Preview

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: ListenerInstance, 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: () => any; logger: LoggerMethods; onConnect: () => boolean; 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<ListenerInstance, 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>;
  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;
}