Repository files navigation

subscriptions-transport-ws was the first implementation of a WebSocket-based GraphQL subscriptions transport in TypeScript. It was created in 2016 and was largely unmaintained after 2018.

Users should migrate tographql-ws, a newer actively-maintained implementation of a similar protocol.

Note that the packages implement distinct protocols, so you must migrate all clients and servers.

If you're using subscriptions with the Apollo platform, theApollo Server docs show how to usegraphql-ws with Apollo Server, Apollo Studio Explorer, Apollo Client Web, Apollo iOS, and Apollo Kotlin. If you have more questions about usinggraphql-ws with the Apollo platform, file an issue on the corresponding repository or post inthe community.

Thegraphql-ws README shows how to integrategraphql-ws with other software.

If you have not yet migrated off ofsubscriptions-transport-ws and need to learn more about it, you can readthe previous version of this file.