Skip to main content
Version: v10.0.0

GraphqlWsAdapter

Socket adapter for GraphQL subscriptions over WebSocket. It speaks graphql-transport-ws , the protocol of the

graphql-ws library - supported by Apollo Server, GraphQL Yoga, Mercurius, Hot Chocolate, Hasura and most others.

  • The connection counts as open once the server acknowledged connection_init , so the socket's

connectionTimeout covers the whole handshake. connectionParams are sent with it, a function runs on every connection attempt.

  • Every document with one set of variables is one server subscription, shared by the listeners with those variables. Subscriptions started before the connection is acknowledged wait for it, and after a reconnect they are sent again.
  • The server's ping is answered, and keepAlive pings a quiet connection to notice when it died.
  • Reconnecting follows the socket's reconnection options. Close codes a retry can't fix (4400, 4401, 4409...) stop it - see shouldReconnectGraphqlWs .
  • With lazy , the connection is open only while there are subscriptions.

Queries and mutations are sent with the GraphqlAdapter​

emit throws.


Import
import { GraphqlWsAdapter } from "@hyper-fetch/graphql"

Usage​

const socket = new Socket({
url: "ws://localhost:4000/graphql",
adapter: GraphqlWsAdapter(),
adapterOptions: { connectionParams: () => ({ token: getToken() }) },
});

const onMessage = socket.createListener()({ topic: "OnMessage", options: { document: OnMessageDocument } });
onMessage.listen(({ data, extra }) => {}, { payload: { room: "general" } });

Parameters​

GraphqlWsAdapter()

Returns​

class SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams> {
constructor(options: { confirmsSubscriptions?: boolean; 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: { confirmsSubscriptions?: boolean; 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, ListenerQueryParams>, any>, VoidFunction>>;
listenerOptions: ListenerOptions | EmptyTypes;
listenerLifecycle: Map<string, Map<ListenerCallbackType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>, any>, ListenerLifecycleType>>;
forceClosed: boolean;
emitterOptions: EmitterOptions | EmptyTypes;
defaultExtra: Extra;
connecting: boolean;
connected: boolean;
confirmsSubscriptions: boolean;
adapterOptions: AdapterOptions | EmptyTypes;
__listenerQueryParams: ListenerQueryParams;
connect() => () => void;
disconnect() => () => void;
emit() => (emitter: EmitterInstance) => void;
listen() => (listener: ListenerOfAdapter<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>>, callback: ListenerCallbackType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>, any>) => RemoveListenerCallbackType;
reconnect() => () => void;
unstable_listenerQueryParamsResolver() => (callback: (...args: any[]) => unknown) => unknown;
dispose() => void;
initialize(socket: SocketInstance) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>;
removeListener(__namedParameters: { callback: ListenerCallbackType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>, any>; topic: string }) => boolean;
setConnected(connected: boolean) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>;
setConnecting(connecting: boolean) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>;
setConnector(connector: (bindings: { adapter: SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>; getQueryParams: (queryParams: undefined | QueryParams) => any; logger: LoggerMethods; onConnect: () => Promise<null | SocketConnectionType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>>>; onConnectFailed: (__namedParameters: { error: Error }) => void; onConnected: (__namedParameters: { resetAttempts?: boolean }) => 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: { callbacks?: ReadonlySet<ListenerCallbackType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>, any>>; data: any; extra: Extra; topic: string }) => void; onListen: (__namedParameters: { callback: ListenerCallbackType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>, any>; listener: Pick<ListenerOfAdapter<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>>, topic>; onUnmount?: VoidFunction }) => () => void; onListenerEnd: (__namedParameters: { callbacks: ReadonlySet<ListenerCallbackType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>, any>>; error?: null | Error; topic: string }) => void; onListenerStart: (__namedParameters: { callbacks: ReadonlySet<ListenerCallbackType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>, any>>; topic: string }) => void; onReconnect: (__namedParameters: { connect: () => Promise<any>; disconnect: () => Promise<any>; manual?: boolean }) => Promise<boolean>; onReconnectFailed: (attempts: number) => void; socket: Socket<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>> }) => Connector<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>>) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>;
setDefaultEmitterOptions(emitterOptions: EmitterOptions | EmptyTypes) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>;
setDefaultExtra(defaultExtra: Extra) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>;
setDefaultListenerOptions(listenerOptions: ListenerOptions | EmptyTypes) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>;
setForceClosed(forceClosed: boolean) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>;
setListenerLifecycle(__namedParameters: { callback: ListenerCallbackType<SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>, any>; lifecycle: ListenerLifecycleType; topic: string }) => void;
setListenerQueryParamsResolver(resolver: (callback: (...args: any[]) => unknown) => unknown) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>;
setOptions(adapterOptions: AdapterOptions | EmptyTypes) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>;
setQueryParams(queryParams: QueryParams) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>;
setQueryParamsConfig(queryParamsConfig: QueryStringifyOptionsType) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>;
setQueryParamsMapper<NewQueryParamsMapper>(queryParamsMapper: NewQueryParamsMapper) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, NewQueryParamsMapper, ListenerQueryParams>;
setQueryParamsMapperConfig<NewQueryParamsMapperConfig>(config: NewQueryParamsMapperConfig) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>;
setReconnectionAttempts(reconnectionAttempts: number) => SocketAdapter<Extra, AdapterOptions, ListenerOptions, EmitterOptions, QueryParams, QueryParamsMapperType, ListenerQueryParams>;
triggerListeners(__namedParameters: { callbacks?: ReadonlySet<ListenerCallbackType<any, any>>; data: any; extra: Extra; topic: string }) => void;
}
GraphqlWsAdapterType