When sets to true
, when no more streams are active, the socket is
automatically disconnected and close. This option should be set to
false
when using Query
or Mutation
over WebSocket transport
to avoid opening/closing the WebSocket connection for each operation
or when multiple short lived Subscription
s are used.
Determines if all streams should automatically restart when the stream receives an error
message type from the server. The stream will try to restart automatically at their latest
marked value (See Stream.mark) if present or at current block if it was never marked.
Determines if all streams should automatically restart when the socket disconnects. The stream will re-connect at their latest marked value (See Stream.mark) if present or at current block if it was never marked.
The delay after the the stream receives an error message to wait for before restarting
the stream. As no effect if GraphqlStreamClientOptions.autoRestartStreamsOnError is sets
to false
.
The Socket instance to use, inferred based on the environment when not provided.
The SocketOptions to pass when creating the default Socket instance. This field has no effect if you provide yourself a StreamClientOptions.socket option.
Generated using TypeDoc
The set of options that can be used when constructing a the default StreamClient instance through the createStreamClient factory method.