Skip to content

Commit 6911685

Browse files
gh-action-runnergh-action-runner
authored andcommitted
Squashed 'apollo-ios/' changes from e7abd715..7e1c45b7
7e1c45b7 Add documentation about using GraphQLQueryWatcher with mutations (#543) git-subtree-dir: apollo-ios git-subtree-split: 7e1c45b74dfd75f1667a4312f73d547667dd61a0
1 parent 9ec86e0 commit 6911685

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

Sources/Apollo/GraphQLQueryWatcher.swift

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,14 @@ import Foundation
33
import ApolloAPI
44
#endif
55

6-
/// 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.
6+
/// A `GraphQLQueryWatcher` is responsible for watching the store, and calling the result handler with a new result
7+
/// whenever any of the data the previous result depends on changes. If your query shares response objects with other
8+
/// operations you should read about normalizing objects by cache key in our documentation. Normalized objects will
9+
/// update all query watchers that had received that object before.
710
///
8-
/// 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.
11+
/// NOTE: The store retains the watcher while subscribed. You must call `cancel()` on your query watcher when you no
12+
/// longer need results. Failure to call `cancel()` before releasing your reference to the returned watcher will
13+
/// result in a memory leak.
914
public final class GraphQLQueryWatcher<Query: GraphQLQuery>: Cancellable, ApolloStoreSubscriber {
1015
weak var client: (any ApolloClientProtocol)?
1116
public let query: Query

0 commit comments

Comments
 (0)