Coherent, zero-dependency, lazy, simple, GraphQL over WebSocket Protocol compliant server and client.
Use Server-Sent Events (SSE) instead? Check out graphql-sse!
Swiftly start with the get started guide on the website.
Short and concise code snippets for starting with common use-cases. Available on the website.
Auto-generated by TypeDoc and then rendered on the website.
Read about the exact transport intricacies used by the library in the GraphQL over WebSocket Protocol document.
File a bug, contribute with code, or improve documentation? Read up on our guidelines for contributing and drive development with yarn test --watch away!
This library and the GraphQL over WebSocket Protocol are not cross-compatible with the deprecated subscriptions-transport-ws and its accompanying Protocol.
You must use graphql-ws coherently and implement the GraphQL over WebSocket Protocol on both sides, server and the client.