Skip to content

Commit

Permalink
Add documentation about using GraphQLQueryWatcher with mutations (#543)
Browse files Browse the repository at this point in the history
  • Loading branch information
damian0815 authored and gh-action-runner committed Nov 21, 2024
1 parent a836ccf commit 259e859
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
9 changes: 7 additions & 2 deletions apollo-ios/Sources/Apollo/GraphQLQueryWatcher.swift
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,14 @@ import Foundation
import ApolloAPI
#endif

/// A `GraphQLQueryWatcher` is responsible for watching the store, and calling the result handler with a new result whenever any of the data the previous result depends on changes.
/// A `GraphQLQueryWatcher` is responsible for watching the store, and calling the result handler with a new result
/// whenever any of the data the previous result depends on changes. If your query shares response objects with other
/// operations you should read about normalizing objects by cache key in our documentation. Normalized objects will
/// update all query watchers that had received that object before.
///
/// NOTE: The store retains the watcher while subscribed. You must call `cancel()` on your query watcher when you no longer need results. Failure to call `cancel()` before releasing your reference to the returned watcher will result in a memory leak.
/// NOTE: The store retains the watcher while subscribed. You must call `cancel()` on your query watcher when you no
/// longer need results. Failure to call `cancel()` before releasing your reference to the returned watcher will
/// result in a memory leak.
public final class GraphQLQueryWatcher<Query: GraphQLQuery>: Cancellable, ApolloStoreSubscriber {
weak var client: (any ApolloClientProtocol)?
public let query: Query
Expand Down
2 changes: 1 addition & 1 deletion docs/source/fetching/queries.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ let watcher = apollo.watch(query: HeroNameQuery()) { result in
}
```

If any of the data for the query changes in the local cache, the result handler will be invoked again.
If your query shares response objects with other operations you will need to implement a [normalized cache](../caching/introduction.mdx) so that object data received in those other operations is written to the local cache and used to update your query watcher by invoking the result handler.

When you call `ApolloClient.watch(query:)` a [`GraphQLQueryWatcher`](https://www.apollographql.com/docs/ios/docc/documentation/apollo/graphqlquerywatcher) is returned. Changes to the query's data will be watched until `cancel()` is called on the watcher.

Expand Down

0 comments on commit 259e859

Please sign in to comment.