Gluon: ApolloSubscription

ApolloClient<NormalizedCacheObject> | null

The Apollo Client instance

Defaults to window.__APOLLO_CLIENT__, which is set by default when creating an Apollo Client. That means that in most cases, it's not necessary to explicity set the client property. For more information see Getting Started: Apollo Client.

Record<string, unknown>

Context passed to the link execution chain.

Data<D> | null

Latest subscription data.

DocumentNode | TypedDocumentNode | null

A GraphQL document containing a single query, mutation, or subscription. You can set it as a JavaScript property or by appending a GraphQL script to the element (light DOM).

'subscription'

Hint that this is a subscription component

Error | ApolloError | null

Latest error

ErrorPolicy

Specifies the Error Policy to be used for this subscription.

Much like fetchPolicy, errorPolicy allows you to control how GraphQL Errors from the server are sent to your UI code. By default, the error policy treats any GraphQL Errors as network errors and ends the request chain. It doesn't save any data in the cache, and renders your UI with the error property set to an ApolloError. By changing this policy per request, you can adjust how GraphQL Errors are managed by your UI. The possible options for errorPolicy are:

• none: This is the default policy to match how Apollo Client 1.0 worked. Any GraphQL Errors are treated the same as network errors and any data is ignored from the response.
• ignore: Ignore allows you to read any data that is returned alongside GraphQL Errors, but doesn't save the errors or report them to your UI.
• all: Using the all policy is the best way to notify your users of potential issues while still showing as much data as possible from your server. It saves both data and errors so your UI can use them.

readonly GraphQLError[] | null

Latest errors.

FetchPolicy

Specifies the FetchPolicy to be used for this subscription.

boolean

Whether a request is in-flight.

boolean

If true, the element will not begin querying data until you manually call subscribe

boolean

Whether or not updates to the network status should trigger next on the observer of this subscription.

Observable<FetchResult<Data<D>>>

Observable watching this element's subscription.

ZenObservable.Subscription

Subscription to the observable

number

The time interval (in milliseconds) on which this subscription should be refetched from the server.

boolean | ((options: SubscriptionDataOptions<D, V>) => boolean)

Determines if your subscription should be unsubscribed and subscribed again.

boolean

If skip is true, the query will be skipped entirely

DocumentNode | TypedDocumentNode

A GraphQL document containing a single subscription. You can set it as a JavaScript property or by appending a GraphQL script to the element (light DOM).

<script type="application/graphql">
  subscription { messages { text } }
</script>

Variables<D, V> | null

An object map from variable name to variable value, where the variables are used within the GraphQL subscription. If the element has not yet subscribed and noAutoSubscribe is not set, setting variables causes the element to subscribe, otherwise, setting variables causes the query to refetch.

Cancels and clears the subscription

void

Lifecycle callback that reacts to changes in the GraphQL document.

Parameters

DocumentNode | TypedDocumentNode | null

void

Callback for when an error occurs.

Parameters

Error

void

Callback for when subscription completes.

void

Callback for when subscription data updates.

Parameters

Data<D>

void

Determines whether the element should attempt to subscribe i.e. begin querying Override to prevent subscribing unless your conditions are met

Parameters

Partial<SubscriptionOptions<Variables<D, V>, Data<D>>>

DocumentNode | TypedDocumentNode

Variables<D, V> 

FetchPolicy

ErrorPolicy

Record<string, unknown>

boolean

Resets the observable and subscribes.

Parameters

Partial<SubscriptionDataOptions<D, V>>

ApolloClient

Record<string, unknown>

ErrorPolicy

FetchPolicy

boolean

boolean

DocumentNode | TypedDocumentNode

Variables<D, V> 

void

Lifecycle callback that reacts to changes in the operation variables.

Parameters

Variables<D, V> | null

void