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.

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

broadcastQueries and subscribeToQuery - where are docs? #3908

Closed
wzup opened this issue Sep 12, 2018 · 2 comments
Closed

broadcastQueries and subscribeToQuery - where are docs? #3908

wzup opened this issue Sep 12, 2018 · 2 comments

Comments

@wzup
Copy link

wzup commented Sep 12, 2018

Intended outcome:
Docs for subscribeToQuery and broadcastQueries.

Actual outcome:
Search on project's site returns nothing for these methods.
But whole community uses them. Just search this repo issues. You'll get 5 open and 19 closed issued for broadcastQueries alone.

How to reproduce the issue:
Just search this repo issues. You'll get 5 open and 19 closed issued for broadcastQueries alone.

Versions

  System:
    OS: macOS High Sierra 10.13.4
  Binaries:
    Node: 8.11.3 - /usr/local/bin/node
    npm: 5.6.0 - /usr/local/bin/npm
  Browsers:
    Chrome: 68.0.3440.106
    Safari: 11.1
  npmPackages:
    apollo-boost: ^0.1.4 => 0.1.10 
    apollo-cache-inmemory: ^1.1.0 => 1.2.5 
    apollo-client: ^2.0.3 => 2.3.5 
    apollo-link: ^1.0.3 => 1.2.2 
    apollo-link-http: ^1.2.0 => 1.5.4 
    react-apollo: ^2.1.1 => 2.1.9 
@wzup
Copy link
Author

wzup commented Sep 23, 2018

Same #3943

@hwillson
Copy link
Member

hwillson commented Sep 23, 2018

subscribeToQuery is no longer used, and broadcastQueries is part of the internal (non-public) API. We don't tend to document internal API functionality, since using it is outside the scope of normal Apollo Client use. If you're interested in seeing what it does, take a look at the QueryManager source.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 16, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants