https://github.com/enisdenjo/graphql-ws

Coherent, zero-dependency, lazy, simple, GraphQL over WebSocket Protocol compliant server and client.
https://github.com/enisdenjo/graphql-ws

apollo client express fastify graphql observables protocol relay server subscriptions the-guild transport uwebsockets websockets

Last synced: 5 days ago
JSON representation

Coherent, zero-dependency, lazy, simple, GraphQL over WebSocket Protocol compliant server and client.

• Host: GitHub
• URL: https://github.com/enisdenjo/graphql-ws
• Owner: enisdenjo
• License: mit
• Created: 2020-07-29T08:45:14.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-11-28T14:50:40.000Z (23 days ago)
• Last Synced: 2024-12-09T21:40:02.275Z (12 days ago)
• Topics: apollo, client, express, fastify, graphql, observables, protocol, relay, server, subscriptions, the-guild, transport, uwebsockets, websockets
• Language: TypeScript
• Homepage: https://the-guild.dev/graphql/ws
• Size: 14.7 MB
• Stars: 1,749
• Watchers: 18
• Forks: 163
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-graphql - graphql-ws - Coherent, zero-dependency, lazy, simple, GraphQL over WebSocket Protocol compliant server and client. (Implementations / JavaScript/TypeScript)
• awesome-list - graphql-ws - dependency, lazy, simple, GraphQL over WebSocket Protocol compliant server and client. | enisdenjo | 646 | (TypeScript)

README

        


  


![GraphQLOverWebSocket](https://user-images.githubusercontent.com/25294569/94527042-172dba00-023f-11eb-944b-88c0bd58a8d2.gif)

  
Coherent, zero-dependency, lazy, simple, GraphQL over WebSocket Protocol compliant server and client.


[![Continuous integration](https://github.com/enisdenjo/graphql-ws/workflows/Continuous%20integration/badge.svg)](https://github.com/enisdenjo/graphql-ws/actions?query=workflow%3A%22Continuous+integration%22) [![graphql-ws](https://img.shields.io/npm/v/graphql-ws.svg?label=graphql-ws&logo=npm)](https://www.npmjs.com/package/graphql-ws)

Use [Server-Sent Events (SSE)](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events) instead? Check out [graphql-sse](https://github.com/enisdenjo/graphql-sse)!

  




## [Get started](https://the-guild.dev/graphql/ws/get-started)

Swiftly start with the [get started guide on the website](https://the-guild.dev/graphql/ws/get-started).

## [Recipes](https://the-guild.dev/graphql/ws/recipes)

Short and concise code snippets for starting with common use-cases. [Available on the website.](https://the-guild.dev/graphql/ws/recipes)

## [Documentation](https://the-guild.dev/graphql/ws/docs)

Auto-generated by [TypeDoc](https://typedoc.org) and then [rendered on the website](https://the-guild.dev/graphql/ws/docs).

## [How does it work?](PROTOCOL.md)

Read about the exact transport intricacies used by the library in the [GraphQL over WebSocket Protocol document](PROTOCOL.md).

## [Want to help?](CONTRIBUTING.md)

File a bug, contribute with code, or improve documentation? Read up on our guidelines for [contributing](CONTRIBUTING.md) and drive development with `yarn test --watch` away!

## Disclaimer

This library and the [GraphQL over WebSocket Protocol](https://github.com/enisdenjo/graphql-ws/blob/master/PROTOCOL.md) are **not** cross-compatible with the [deprecated `subscriptions-transport-ws`](https://github.com/apollographql/subscriptions-transport-ws) and its [accompanying Protocol](https://github.com/apollographql/subscriptions-transport-ws/blob/master/PROTOCOL.md).

You must use `graphql-ws` coherently and implement the [GraphQL over WebSocket Protocol](https://github.com/enisdenjo/graphql-ws/blob/master/PROTOCOL.md) on both sides, server and the client.