Skip to content

Commit

Permalink
Update GraphQLProtocol documentation
Browse files Browse the repository at this point in the history
The Graphql-ws library does implement graphqlTransportWs now.
See their readme: https://github.com/enisdenjo/graphql-ws/blob/master/PROTOCOL.md#communication
"The WebSocket sub-protocol for this specification is: graphql-transport-ws."
  • Loading branch information
apackin authored Jul 11, 2024
1 parent 9052e60 commit a82be82
Showing 1 changed file with 3 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -176,15 +176,13 @@ class SocketSubProtocol {
class GraphQLProtocol {
GraphQLProtocol._();

/// graphql-ws: The new (not to be confused with the graphql-ws library).
/// graphql-ws: Old protocol (not to be confused with the graphql-ws library).
/// NB. This protocol is it no longer maintained, please consider
/// to use `SocketSubProtocol.graphqlTransportWs`.
static const String graphqlWs = "graphql-ws";

/// graphql-transport-ws: New ws protocol used by most Apollo Server instances
/// with subscriptions enabled use this library.
/// N.B: not to be confused with the graphql-ws library that implement the
/// old ws protocol.
/// graphql-transport-ws: New protocol used by most Apollo Server instances
/// with subscriptions enabled. Implemented by the graphql-ws library.
static const String graphqlTransportWs = "graphql-transport-ws";
}

Expand Down

0 comments on commit a82be82

Please sign in to comment.