Interface IApolloClient<T>

cache

defaultOptions

disableNetworkFetches

link

queryDeduplication

Readonly typeDefs

version

__actionHookForDevTools

• __actionHookForDevTools(cb): void

• Parameters

  • cb: (() => any)

    • • (): any

      • Returns any

  Returns void

__requestRaw

• __requestRaw(payload): Observable<ExecutionResult<{
      [key: string]: any;
  }, {
      [key: string]: any;
  }>>

• Parameters

  • payload: GraphQLRequest<Record<string, any>>

  Returns Observable<ExecutionResult<{
      [key: string]: any;
  }, {
      [key: string]: any;
  }>>

addResolvers

• addResolvers(resolvers): void

• Parameters

  • resolvers: Resolvers | Resolvers[]

  Returns void

clearStore

• clearStore(): Promise<any[]>

• Returns Promise<any[]>

extract

• extract(optimistic?): T

• Parameters

  • Optional optimistic: boolean

  Returns T

getObservableQueries

• getObservableQueries(include?): Map<string, ObservableQuery<any, OperationVariables>>

• Parameters

  • Optional include: RefetchQueriesInclude

  Returns Map<string, ObservableQuery<any, OperationVariables>>

getResolvers

• getResolvers(): Resolvers

• Returns Resolvers

mutate

• mutate<TData, TVariables, TContext, TCache>(options): Promise<FetchResult<TData>>

• Type Parameters

  • TData = any

  • TVariables extends OperationVariables = OperationVariables

  • TContext extends Record<string, any> = DefaultContext

  • TCache extends ApolloCache<any> = ApolloCache<any>

  Parameters

  • options: MutationOptions<TData, TVariables, TContext, ApolloCache<any>>

  Returns Promise<FetchResult<TData>>

onClearStore

• onClearStore(cb): (() => void)

• Parameters

  • cb: (() => Promise<any>)

    • • (): Promise<any>

      • Returns Promise<any>

  Returns (() => void)

  • • (): void

    • Returns void

onResetStore

• onResetStore(cb): (() => void)

• Parameters

  • cb: (() => Promise<any>)

    • • (): Promise<any>

      • Returns Promise<any>

  Returns (() => void)

  • • (): void

    • Returns void

query

• query<T, TVariables>(options): Promise<ApolloQueryResult<T>>

• Type Parameters

  • T = any

  • TVariables extends OperationVariables = OperationVariables

  Parameters

  • options: QueryOptions<TVariables, T>

  Returns Promise<ApolloQueryResult<T>>

reFetchObservableQueries

• reFetchObservableQueries(includeStandby?): Promise<ApolloQueryResult<any>[]>

• Parameters

  • Optional includeStandby: boolean

  Returns Promise<ApolloQueryResult<any>[]>

readFragment

• readFragment<T, TVariables>(options, optimistic?): T

• Type Parameters

  • T = any

  • TVariables = OperationVariables

  Parameters

  • options: Fragment<TVariables, T>

  • Optional optimistic: boolean

  Returns T

readQuery

• readQuery<T, TVariables>(options, optimistic?): T

• Type Parameters

  • T = any

  • TVariables = OperationVariables

  Parameters

  • options: Query<TVariables, T>

  • Optional optimistic: boolean

  Returns T

refetchQueries

• refetchQueries<TCache, TResult>(options): RefetchQueriesResult<TResult>

• Type Parameters

  • TCache extends ApolloCache<any> = ApolloCache<T>

  • TResult = Promise<ApolloQueryResult<any>>

  Parameters

  • options: RefetchQueriesOptions<TCache, TResult>

  Returns RefetchQueriesResult<TResult>

resetStore

• resetStore(): Promise<ApolloQueryResult<any>[]>

• Returns Promise<ApolloQueryResult<any>[]>

restore

• restore(serializedState): ApolloCache<T>

• Parameters

  • serializedState: T

  Returns ApolloCache<T>

setLink

• setLink(newLink): void

• Parameters

  • newLink: ApolloLink

  Returns void

setLocalStateFragmentMatcher

• setLocalStateFragmentMatcher(fragmentMatcher): void

• Parameters

  • fragmentMatcher: FragmentMatcher

  Returns void

setResolvers

• setResolvers(resolvers): void

• Parameters

  • resolvers: Resolvers | Resolvers[]

  Returns void

stop

• stop(): void

• Returns void

subscribe

• subscribe<T, TVariables>(options): Observable<FetchResult<T>>

• Type Parameters

  • T = any

  • TVariables extends OperationVariables = OperationVariables

  Parameters

  • options: SubscriptionOptions<TVariables, T>

  Returns Observable<FetchResult<T>>

watchQuery

• watchQuery<T, TVariables>(options): ObservableQuery<T, TVariables>

• Type Parameters

  • T = any

  • TVariables extends OperationVariables = OperationVariables

  Parameters

  • options: WatchQueryOptions<TVariables, T>

  Returns ObservableQuery<T, TVariables>

writeFragment

• writeFragment<TData, TVariables>(options): Reference

• Type Parameters

  • TData = any

  • TVariables = OperationVariables

  Parameters

  • options: WriteFragmentOptions<TData, TVariables>

  Returns Reference

writeQuery

• writeQuery<TData, TVariables>(options): Reference

• Type Parameters

  • TData = any

  • TVariables = OperationVariables

  Parameters

  • options: WriteQueryOptions<TData, TVariables>

  Returns Reference