Coherent, zero-dependency, lazy, simple, GraphQL over WebSocket Protocol compliant server and client.
See the codeREADME
Coherent, zero-dependency, lazy, simple, GraphQL over WebSocket Protocol compliant server and client.
Use Server-Sent Events (SSE) instead? Check out graphql-sse!
Get started
Swiftly start with the get started guide on the website.
Recipes
Short and concise code snippets for starting with common use-cases. Available on the website.
Documentation
Auto-generated by TypeDoc and then rendered on the website.
How does it work?
Read about the exact transport intricacies used by the library in the GraphQL over WebSocket Protocol document.
Want to help?
File a bug, contribute with code, or improve documentation? Read up on our guidelines for contributing and drive development with yarn test --watch away!
Disclaimer
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.
Significant stargazers
325 followers · starred Dec 2025
1,233 followers · starred Feb 2021
89 followers · starred Feb 2021
167 followers · starred Aug 2022
Similar repos
Languages
TypeScript
84.0%
MDX
14.9%
JavaScript
1.1%
Coherent, zero-dependency, lazy, simple, GraphQL over WebSocket Protocol compliant server and client.
See the codeREADME
Coherent, zero-dependency, lazy, simple, GraphQL over WebSocket Protocol compliant server and client.
Use Server-Sent Events (SSE) instead? Check out graphql-sse!
Get started
Swiftly start with the get started guide on the website.
Recipes
Short and concise code snippets for starting with common use-cases. Available on the website.
Documentation
Auto-generated by TypeDoc and then rendered on the website.
How does it work?
Read about the exact transport intricacies used by the library in the GraphQL over WebSocket Protocol document.
Want to help?
File a bug, contribute with code, or improve documentation? Read up on our guidelines for contributing and drive development with yarn test --watch away!
Disclaimer
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.
Similar repos
Significant stargazers
325 followers · starred Dec 2025
1,233 followers · starred Feb 2021
89 followers · starred Feb 2021
167 followers · starred Aug 2022
Languages
TypeScript
84.0%
MDX
14.9%
JavaScript
1.1%