Remake of subscriptions-transport-socketio which is a remake of subscriptions-transport-ws
ref
: SocketIO instance
options
query
: GraphQL subscriptionvariables
: GraphQL subscription variablesoperationName
: operation name of the subscription
handler: (errors, result) => void
: function to handle any errors and results from the subscription response
id
: the subscription ID of the subscription to unsubscribe fro
options
schema
: Executable Schemapubsub
: GraphQL subscription manager
ref
: SocketIO instance
Each message has a type, as well as associated fields depending on the message type.
Client sends this message to start a subscription for a query.
query
: GraphQL subscriptionvariables
: GraphQL subscription variablesoperationName
: operation name of the subscriptionid
: subscription ID
Client sends this message to end a subscription.
id
: subscription ID of the subscription to be terminated
The server sends this message to confirm that it has validated the subscription query and is subscribed to the triggers.
id
: ID of the subscription that was successfully set up
Server sends this message upon failing to register a subscription. It may also send this message at any point during the subscription to notify the client the the subscription has been stopped.
errors
: array of errors attributed to the subscription failing on the serverid
: subscription ID of the subscription that failed on the server
GraphQL result sent periodically from server to client according to subscription.
payload
: GraphQL result from running the subscriptionid
: subscription ID