api documentation for apollo-client (v1.0.4)

A simple yet functional GraphQL client.

table of contents

  1. module apollo-client
    1. function apollo-client.ApolloClient (options)
    2. function apollo-client.ApolloError (_a)
    3. function apollo-client.HTTPBatchedNetworkInterface (uri, batchInterval, fetchOpts)
    4. function apollo-client.HTTPFetchNetworkInterface ()
    5. function apollo-client.IntrospectionFragmentMatcher (options)
    6. function apollo-client.ObservableQuery (_a)
    7. function apollo-client.addTypenameToDocument (doc)
    8. function apollo-client.createApolloReducer (config)
    9. function apollo-client.createApolloStore (_a)
    10. function apollo-client.createBatchingNetworkInterface (options)
    11. function apollo-client.createFragmentMap (fragments)
    12. function apollo-client.createNetworkInterface (uriOrInterfaceOpts, secondArgOpts)
    13. function apollo-client.default (options)
    14. function apollo-client.getFragmentDefinitions (doc)
    15. function apollo-client.getQueryDefinition (doc)
    16. function apollo-client.printAST (ast)
    17. function apollo-client.readQueryFromStore (options)
    18. function apollo-client.toIdValue (id, generated)
    19. function apollo-client.writeQueryToStore (_a)
    20. object apollo-client.ApolloClient.prototype
    21. object apollo-client.ApolloError.prototype
    22. object apollo-client.HTTPBatchedNetworkInterface.prototype
    23. object apollo-client.HTTPFetchNetworkInterface.prototype
    24. object apollo-client.IntrospectionFragmentMatcher.prototype
    25. object apollo-client.NetworkStatus
    26. object apollo-client.ObservableQuery.prototype
  2. module apollo-client.ApolloClient
    1. function apollo-client.ApolloClient (options)
  3. module apollo-client.ApolloClient.prototype
    1. function apollo-client.ApolloClient.prototype.__actionHookForDevTools (cb)
    2. function apollo-client.ApolloClient.prototype.getInitialState ()
    3. function apollo-client.ApolloClient.prototype.initProxy ()
    4. function apollo-client.ApolloClient.prototype.initStore ()
    5. function apollo-client.ApolloClient.prototype.mutate (options)
    6. function apollo-client.ApolloClient.prototype.query (options)
    7. function apollo-client.ApolloClient.prototype.readFragment (options)
    8. function apollo-client.ApolloClient.prototype.readQuery (options)
    9. function apollo-client.ApolloClient.prototype.reducer ()
    10. function apollo-client.ApolloClient.prototype.resetStore ()
    11. function apollo-client.ApolloClient.prototype.setStore (store)
    12. function apollo-client.ApolloClient.prototype.subscribe (options)
    13. function apollo-client.ApolloClient.prototype.watchQuery (options)
    14. function apollo-client.ApolloClient.prototype.writeFragment (options)
    15. function apollo-client.ApolloClient.prototype.writeQuery (options)
  4. module apollo-client.ApolloError
    1. function apollo-client.ApolloError (_a)
  5. module apollo-client.ApolloError.prototype
    1. function apollo-client.ApolloError.prototype.constructor (_a)
  6. module apollo-client.HTTPBatchedNetworkInterface
    1. function apollo-client.HTTPBatchedNetworkInterface (uri, batchInterval, fetchOpts)
  7. module apollo-client.HTTPBatchedNetworkInterface.prototype
    1. function apollo-client.HTTPBatchedNetworkInterface.prototype.applyBatchAfterwares (_a)
    2. function apollo-client.HTTPBatchedNetworkInterface.prototype.applyBatchMiddlewares (_a)
    3. function apollo-client.HTTPBatchedNetworkInterface.prototype.batchQuery (requests)
    4. function apollo-client.HTTPBatchedNetworkInterface.prototype.batchedFetchFromRemoteEndpoint (batchRequestAndOptions)
    5. function apollo-client.HTTPBatchedNetworkInterface.prototype.constructor (uri, batchInterval, fetchOpts)
    6. function apollo-client.HTTPBatchedNetworkInterface.prototype.query (request)
    7. function apollo-client.HTTPBatchedNetworkInterface.prototype.use (middlewares)
    8. function apollo-client.HTTPBatchedNetworkInterface.prototype.useAfter (afterwares)
  8. module apollo-client.HTTPFetchNetworkInterface
    1. function apollo-client.HTTPFetchNetworkInterface ()
  9. module apollo-client.HTTPFetchNetworkInterface.prototype
    1. function apollo-client.HTTPFetchNetworkInterface.prototype.applyAfterwares (_a)
    2. function apollo-client.HTTPFetchNetworkInterface.prototype.applyMiddlewares (requestAndOptions)
    3. function apollo-client.HTTPFetchNetworkInterface.prototype.constructor ()
    4. function apollo-client.HTTPFetchNetworkInterface.prototype.fetchFromRemoteEndpoint (_a)
    5. function apollo-client.HTTPFetchNetworkInterface.prototype.query (request)
    6. function apollo-client.HTTPFetchNetworkInterface.prototype.use (middlewares)
    7. function apollo-client.HTTPFetchNetworkInterface.prototype.useAfter (afterwares)
  10. module apollo-client.IntrospectionFragmentMatcher
    1. function apollo-client.IntrospectionFragmentMatcher (options)
  11. module apollo-client.IntrospectionFragmentMatcher.prototype
    1. function apollo-client.IntrospectionFragmentMatcher.prototype.match (idValue, typeCondition, context)
    2. function apollo-client.IntrospectionFragmentMatcher.prototype.parseIntrospectionResult (introspectionResultData)
  12. module apollo-client.ObservableQuery
    1. function apollo-client.ObservableQuery (_a)
  13. module apollo-client.ObservableQuery.prototype
    1. function apollo-client.ObservableQuery.prototype.constructor (_a)
    2. function apollo-client.ObservableQuery.prototype.currentResult ()
    3. function apollo-client.ObservableQuery.prototype.fetchMore (fetchMoreOptions)
    4. function apollo-client.ObservableQuery.prototype.getLastResult ()
    5. function apollo-client.ObservableQuery.prototype.onSubscribe (observer)
    6. function apollo-client.ObservableQuery.prototype.refetch (variables)
    7. function apollo-client.ObservableQuery.prototype.result ()
    8. function apollo-client.ObservableQuery.prototype.setOptions (opts)
    9. function apollo-client.ObservableQuery.prototype.setUpQuery ()
    10. function apollo-client.ObservableQuery.prototype.setVariables (variables, tryFetch)
    11. function apollo-client.ObservableQuery.prototype.startPolling (pollInterval)
    12. function apollo-client.ObservableQuery.prototype.stopPolling ()
    13. function apollo-client.ObservableQuery.prototype.subscribeToMore (options)
    14. function apollo-client.ObservableQuery.prototype.tearDownQuery ()
    15. function apollo-client.ObservableQuery.prototype.updateQuery (mapFn)

module apollo-client

function apollo-client.ApolloClient (options)

function apollo-client.ApolloError (_a)

function apollo-client.HTTPBatchedNetworkInterface (uri, batchInterval, fetchOpts)

function apollo-client.HTTPFetchNetworkInterface ()

function apollo-client.IntrospectionFragmentMatcher (options)

function apollo-client.ObservableQuery (_a)

function apollo-client.addTypenameToDocument (doc)

function apollo-client.createApolloReducer (config)

function apollo-client.createApolloStore (_a)

function apollo-client.createBatchingNetworkInterface (options)

function apollo-client.createFragmentMap (fragments)

function apollo-client.createNetworkInterface (uriOrInterfaceOpts, secondArgOpts)

function apollo-client.default (options)

function apollo-client.getFragmentDefinitions (doc)

function apollo-client.getQueryDefinition (doc)

function apollo-client.printAST (ast)

function apollo-client.readQueryFromStore (options)

function apollo-client.toIdValue (id, generated)

function apollo-client.writeQueryToStore (_a)

module apollo-client.ApolloClient

function apollo-client.ApolloClient (options)

module apollo-client.ApolloClient.prototype

function apollo-client.ApolloClient.prototype.__actionHookForDevTools (cb)

function apollo-client.ApolloClient.prototype.getInitialState ()

function apollo-client.ApolloClient.prototype.initProxy ()

function apollo-client.ApolloClient.prototype.initStore ()

function apollo-client.ApolloClient.prototype.mutate (options)

function apollo-client.ApolloClient.prototype.query (options)

function apollo-client.ApolloClient.prototype.readFragment (options)

function apollo-client.ApolloClient.prototype.readQuery (options)

function apollo-client.ApolloClient.prototype.reducer ()

function apollo-client.ApolloClient.prototype.resetStore ()

function apollo-client.ApolloClient.prototype.setStore (store)

function apollo-client.ApolloClient.prototype.subscribe (options)

function apollo-client.ApolloClient.prototype.watchQuery (options)

function apollo-client.ApolloClient.prototype.writeFragment (options)

function apollo-client.ApolloClient.prototype.writeQuery (options)

module apollo-client.ApolloError

function apollo-client.ApolloError (_a)

module apollo-client.ApolloError.prototype

function apollo-client.ApolloError.prototype.constructor (_a)

module apollo-client.HTTPBatchedNetworkInterface

function apollo-client.HTTPBatchedNetworkInterface (uri, batchInterval, fetchOpts)

module apollo-client.HTTPBatchedNetworkInterface.prototype

function apollo-client.HTTPBatchedNetworkInterface.prototype.applyBatchAfterwares (_a)

function apollo-client.HTTPBatchedNetworkInterface.prototype.applyBatchMiddlewares (_a)

function apollo-client.HTTPBatchedNetworkInterface.prototype.batchQuery (requests)

function apollo-client.HTTPBatchedNetworkInterface.prototype.batchedFetchFromRemoteEndpoint (batchRequestAndOptions)

function apollo-client.HTTPBatchedNetworkInterface.prototype.constructor (uri, batchInterval, fetchOpts)

function apollo-client.HTTPBatchedNetworkInterface.prototype.query (request)

function apollo-client.HTTPBatchedNetworkInterface.prototype.use (middlewares)

function apollo-client.HTTPBatchedNetworkInterface.prototype.useAfter (afterwares)

module apollo-client.HTTPFetchNetworkInterface

function apollo-client.HTTPFetchNetworkInterface ()

module apollo-client.HTTPFetchNetworkInterface.prototype

function apollo-client.HTTPFetchNetworkInterface.prototype.applyAfterwares (_a)

function apollo-client.HTTPFetchNetworkInterface.prototype.applyMiddlewares (requestAndOptions)

function apollo-client.HTTPFetchNetworkInterface.prototype.constructor ()

function apollo-client.HTTPFetchNetworkInterface.prototype.fetchFromRemoteEndpoint (_a)

function apollo-client.HTTPFetchNetworkInterface.prototype.query (request)

function apollo-client.HTTPFetchNetworkInterface.prototype.use (middlewares)

function apollo-client.HTTPFetchNetworkInterface.prototype.useAfter (afterwares)

module apollo-client.IntrospectionFragmentMatcher

function apollo-client.IntrospectionFragmentMatcher (options)

module apollo-client.IntrospectionFragmentMatcher.prototype

function apollo-client.IntrospectionFragmentMatcher.prototype.match (idValue, typeCondition, context)

function apollo-client.IntrospectionFragmentMatcher.prototype.parseIntrospectionResult (introspectionResultData)

module apollo-client.ObservableQuery

function apollo-client.ObservableQuery (_a)

module apollo-client.ObservableQuery.prototype

function apollo-client.ObservableQuery.prototype.constructor (_a)

function apollo-client.ObservableQuery.prototype.currentResult ()

function apollo-client.ObservableQuery.prototype.fetchMore (fetchMoreOptions)

function apollo-client.ObservableQuery.prototype.getLastResult ()

function apollo-client.ObservableQuery.prototype.onSubscribe (observer)

function apollo-client.ObservableQuery.prototype.refetch (variables)

function apollo-client.ObservableQuery.prototype.result ()

function apollo-client.ObservableQuery.prototype.setOptions (opts)

function apollo-client.ObservableQuery.prototype.setUpQuery ()

function apollo-client.ObservableQuery.prototype.setVariables (variables, tryFetch)

function apollo-client.ObservableQuery.prototype.startPolling (pollInterval)

function apollo-client.ObservableQuery.prototype.stopPolling ()

function apollo-client.ObservableQuery.prototype.subscribeToMore (options)

function apollo-client.ObservableQuery.prototype.tearDownQuery ()

function apollo-client.ObservableQuery.prototype.updateQuery (mapFn)

[ this document was created with utility2 ]