Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add note about the store retaining the query watcher #1048

Merged
merged 3 commits into from
Feb 29, 2020
Merged

Add note about the store retaining the query watcher #1048

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
90db3cf
add note about the store retaining the query watcher
designatednerd Feb 28, 2020
3feafee
Apply @anthonymdev's suggestion for wording
designatednerd Feb 29, 2020
42ee606
Update docs on watcher to be more explicit about cancelling
designatednerd Feb 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Sources/Apollo/GraphQLQueryWatcher.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import Dispatch

/// 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.
///
/// NOTE: The store retains the watcher and does not automatically unsubscribe you. You must call `cancel()` on your query watcher when you no longer need results.
designatednerd marked this conversation as resolved.
Show resolved Hide resolved
public final class GraphQLQueryWatcher<Query: GraphQLQuery>: Cancellable, ApolloStoreSubscriber {
weak var client: ApolloClientProtocol?
public let query: Query
Expand Down