@graphql-ez/plugin-websockets NPM

@graphql-ez/plugin-websockets

Integration with:

GraphQL over WebSocket Protocol - graphql-ws
Legacy Support for subscriptions-transport-ws (using a fork called subscriptions-transport-ws-envelop)

Usage

import { ezWebSockets } from '@graphql-ez/plugin-websockets';

const ezApp = CreateApp({
  ez: {
    plugins: [
      ezWebSockets('adaptive'),
      // ...
    ],
  },
  // ...
});

export type WebSocketOptions =
  // If you enable both protocols, it will automatically adapt to the correct protocol based on the client
  | {
      subscriptionsTransport?:
        | {
            rootValue?: any;
            validationRules?: readonly any[] | ((context: ValidationContext) => any)[];
            onOperation?: Function;
            onOperationComplete?: Function;
            onDisconnect?: Function;
            keepAlive?: number;
          }
        | boolean;
      // Check https://github.com/enisdenjo/graphql-ws/blob/master/docs/interfaces/server.serveroptions.md
      graphQLWS?: Omit<GraphQLWSOptions, 'schema' | 'execute' | 'subscribe' | 'context' | 'validate' | 'onSubscribe'> | boolean;
      wsOptions?: {
        verifyClient?:
          | ((
              info: {
                origin: string;
                secure: boolean;
                req: IncomingMessage;
              },
              callback: (res: boolean, code?: number, message?: string, headers?: OutgoingHttpHeaders) => void
            ) => void)
          | ((info: { origin: string; secure: boolean; req: IncomingMessage }) => boolean);
        clientTracking?: boolean;
        perMessageDeflate?: boolean | PerMessageDeflateOptions;
        maxPayload?: number;
      };
    }
  // Only use graphql-ws library protocol
  | 'new'
  // Only use legacy subscriptions-transport-ws protocol
  | 'legacy'
  // Automatically use the correct protocol based on the client, the default value
  | 'adaptive';