Skip to content

Commit a82be82

Browse files
authored
Update GraphQLProtocol documentation
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."
1 parent 9052e60 commit a82be82

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

packages/graphql/lib/src/links/websocket_link/websocket_client.dart

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -176,15 +176,13 @@ class SocketSubProtocol {
176176
class GraphQLProtocol {
177177
GraphQLProtocol._();
178178

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

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

0 commit comments

Comments
 (0)