You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
40 lines
2.3 KiB
40 lines
2.3 KiB
4 months ago
|
<div align="center">
|
||
|
|
<br />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h6>Coherent, zero-dependency, lazy, simple, <a href="PROTOCOL.md">GraphQL over WebSocket Protocol</a> compliant server and client.</h6>
|
||
|
|
|
||
|
|
[](https://github.com/enisdenjo/graphql-ws/actions?query=workflow%3A%22Continuous+integration%22) [](https://www.npmjs.com/package/graphql-ws)
|
||
|
|
|
||
|
|
<i>Use [Server-Sent Events (SSE)](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events) instead? Check out <b>[graphql-sse](https://github.com/enisdenjo/graphql-sse)</b>!</i>
|
||
|
|
|
||
|
|
<br />
|
||
|
|
</div>
|
||
|
|
|
||
|
|
## [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.
|