graphql-ws
Coherent, zero-dependency, lazy, simple, GraphQL over WebSocket Protocol compliant server and client
About
Coherent, zero-dependency, lazy, simple, GraphQL over WebSocket Protocol compliant server and client
Live mirror of the GitHub README. Updated whenever the repo's default branch changes.
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.
Quick facts
npm install graphql-wsCommon pairings
Packages this one expects to find in the same project. Each is also a Sourcemap Explorer detection target.
How Sourcemap Explorer detects graphql-ws
We catch graphql-ws from two complementary signals: bundled source paths and the embedded package.json. Modern bundlers (webpack, Vite, esbuild, Rollup, Turbopack) preserve the original node_modules/graphql-ws/ paths inside the JavaScript sourcemap's sources[] array — that's the canonical signal. When the matching package.json is also captured in sourcesContent[], we read the exact version field — patch number included. No regex guessing, no version inference.
- 1
Confirm the site exposes sourcemaps
In DevTools Network, check the response headers of any application script for `SourceMap` or `X-SourceMap`. Failing that, fetch the script's last 4 KB and look for a `//# sourceMappingURL=` comment.
- 2
Find the package in the bundle
Open DevTools → Network → reload. Click any application script and look at its sourcemap. Inside, search `sources[]` for entries matching `node_modules/graphql-ws/` — every match confirms the package is bundled. The matching `sourcesContent[i]` for `node_modules/graphql-ws/package.json` gives you the exact installed version.
- 3
Read the version directly from package.json
Run `jq -r '. as $m | $m.sources | to_entries[] | select(.value | endswith("node_modules/graphql-ws/package.json")) | $m.sourcesContent[.key] | fromjson | .version' bundle.js.map`. Sourcemap Explorer automates the same query in the popup.
Recent versions
FAQ
What is graphql-ws used for?
Coherent, zero-dependency, lazy, simple, GraphQL over WebSocket Protocol compliant server and client
How can I tell if a website is using graphql-ws?
Open the page in Chrome with the Sourcemap Explorer extension installed and read the Stack tab. We catch `graphql-ws` from two complementary signals: `node_modules/graphql-ws/` paths inside the JavaScript sourcemap, and the embedded `package.json` we read for exact-version detection. Without the extension you can do the same lookup manually in DevTools — the steps are listed in the "How Sourcemap Explorer detects" section above.
What is the latest version of graphql-ws?
6.0.8, as published on the npm registry. The "Recent versions" table on this page lists the most recent 8 releases with their release dates. Sourcemap Explorer reports the version actually bundled into a site, which can lag the latest release by months on real-world deployments.
Where can I read more?
Project homepage: https://the-guild.dev/graphql/ws. Source code: https://github.com/enisdenjo/graphql-ws. Published on npm: https://www.npmjs.com/package/graphql-ws. Licensed as MIT.
Keep reading on Sourcemap Explorer
Practical guides
Detection deep dives
Alternative tools
Detected by Sourcemap Explorer
When a bundle ships sourcemaps, we read the embedded package.json for graphql-ws and report the precise version. Without sourcemaps, an import / require in the page's scripts is enough to flag it.