The inputs to
urql's Exchange pipeline to instruct them to execute a GraphQL operation.
urql, starts a GraphQLRequest and are events. The
kind of an
be set to any operation kind of GraphQL, namely
subscription. To terminate an
operation, once it's cancelled, a
teardown kind event is sent.
https://urql.dev/goto/docs/architecture/#the-client-and-exchanges for more information on the flow of Exchanges.
Additional metadata that a GraphQL API may accept for spec extensions.
https://github.com/graphql/graphql-over-http/blob/1928447/spec/GraphQLOverHTTP.md#request-parameters for the GraphQL over HTTP spec
Unique identifier for the
This is a key that combines the unique key of the
query and the
variables into a unique
key for the
GraphQLRequest. Any request with the same query and variables will have a unique
key by which results and requests can be identified as identical.
Internally, a stable, cached
key is generated for the
DocumentNode and for the
both will be combined into a combined
key which is set here, based on a DJB2 hash,
variables will change the key even if they contain a non-JSON reference. If you pass a custom
class instance to
variables that doesn't contain a
toJSON method, a stable but random
identifier will replace this class to generate a key.
OperationType describing the kind of
This is used to describe what to do with the GraphQLRequest of an Operation and is set
to a GraphQL operation type (
subscription) to start an
Operation; and to
teardown to cancel an operation, which either terminates it early or lets exchanges know that no
consumer is interested in this operation any longer.
A GraphQL document to execute against a cache or API.
GraphQLRequest is executed against an operation in a GraphQL document.
urql, we expect a document to only contain a single operation that is executed rather than
multiple ones by convention.
Generated using TypeDoc