https://github.com/apollographql/subscriptions-transport-ws

:arrows_clockwise: A WebSocket client + server for GraphQL subscriptions
https://github.com/apollographql/subscriptions-transport-ws

Last synced: 4 months ago
JSON representation

:arrows_clockwise: A WebSocket client + server for GraphQL subscriptions

• Host: GitHub
• URL: https://github.com/apollographql/subscriptions-transport-ws
• Owner: apollographql
• License: mit
• Archived: true
• Created: 2016-07-19T22:58:49.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-04-14T11:28:28.000Z (over 1 year ago)
• Last Synced: 2024-04-12T00:13:29.351Z (9 months ago)
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/subscriptions-transport-ws
• Size: 3.49 MB
• Stars: 1,515
• Watchers: 71
• Forks: 345
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

• awesome - subscriptions-transport-ws - :arrows_clockwise: A WebSocket client + server for GraphQL subscriptions (TypeScript)
• stars - apollographql/subscriptions-transport-ws
• awesome-starred - apollographql/subscriptions-transport-ws - :arrows_clockwise: A WebSocket client + server for GraphQL subscriptions (others)

README

        
# `subscriptions-transport-ws` is no longer maintained

`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 to [`graphql-ws`](https://github.com/enisdenjo/graphql-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, the [Apollo Server docs](https://www.apollographql.com/docs/apollo-server/data/subscriptions/#switching-from-subscriptions-transport-ws) show how to use `graphql-ws` with Apollo Server, Apollo Studio Explorer, Apollo Client Web, Apollo iOS, and Apollo Kotlin. If you have more questions about using `graphql-ws` with the Apollo platform, file an issue on the corresponding repository or post in [the community](https://community.apollographql.com/).

The [`graphql-ws` README](https://github.com/enisdenjo/graphql-ws/blob/master/README.md) shows how to integrate `graphql-ws` with other software.

If you have not yet migrated off of `subscriptions-transport-ws` and need to learn more about it, you can read [the previous version of this file](https://github.com/apollographql/subscriptions-transport-ws/blob/51270cc7dbaf09c7b9aa67368f1de58148c7d334/README.md).