interface IApolloClient<T> {
    cache: ApolloCache<T>;
    defaultOptions: DefaultOptions;
    disableNetworkFetches: boolean;
    jwt_token?: string;
    link: ApolloLink;
    path?: string;
    queryDeduplication: boolean;
    ssl?: boolean;
    typeDefs: string | string[] | DocumentNode | DocumentNode[];
    version: string;
    __actionHookForDevTools(cb): void;
    __requestRaw(payload): Observable<ExecutionResult<{
        [key: string]: any;
    }, {
        [key: string]: any;
    }>>;
    addResolvers(resolvers): void;
    clearStore(): Promise<any[]>;
    extract(optimistic?): T;
    getObservableQueries(include?): Map<string, ObservableQuery<any, OperationVariables>>;
    getResolvers(): Resolvers;
    mutate<TData, TVariables, TContext, TCache>(options): Promise<FetchResult<TData>>;
    onClearStore(cb): (() => void);
    onResetStore(cb): (() => void);
    query<T, TVariables>(options): Promise<ApolloQueryResult<T>>;
    reFetchObservableQueries(includeStandby?): Promise<ApolloQueryResult<any>[]>;
    readFragment<T, TVariables>(options, optimistic?): T;
    readQuery<T, TVariables>(options, optimistic?): T;
    refetchQueries<TCache, TResult>(options): RefetchQueriesResult<TResult>;
    resetStore(): Promise<ApolloQueryResult<any>[]>;
    restore(serializedState): ApolloCache<T>;
    setLink(newLink): void;
    setLocalStateFragmentMatcher(fragmentMatcher): void;
    setResolvers(resolvers): void;
    stop(): void;
    subscribe<T, TVariables>(options): Observable<FetchResult<T>>;
    watchQuery<T, TVariables>(options): ObservableQuery<T, TVariables>;
    writeFragment<TData, TVariables>(options): Reference;
    writeQuery<TData, TVariables>(options): Reference;
}

Type Parameters

  • T

Hierarchy

  • ApolloClient<T>
    • IApolloClient

Properties

cache: ApolloCache<T>
defaultOptions: DefaultOptions
disableNetworkFetches: boolean
jwt_token?: string
link: ApolloLink
path?: string
queryDeduplication: boolean
ssl?: boolean
typeDefs: string | string[] | DocumentNode | DocumentNode[]
version: string

Methods

  • Parameters

    • cb: (() => any)
        • (): any
        • Returns any

    Returns void

  • Parameters

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

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

  • Parameters

    • resolvers: Resolvers | Resolvers[]

    Returns void

  • Returns Promise<any[]>

  • Parameters

    • Optional optimistic: boolean

    Returns T

  • Parameters

    • Optional include: RefetchQueriesInclude

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

  • Returns Resolvers

  • Type Parameters

    • TData = any
    • TVariables extends OperationVariables = OperationVariables
    • TContext extends Record<string, any> = DefaultContext
    • TCache extends ApolloCache<any> = ApolloCache<any>

    Parameters

    Returns Promise<FetchResult<TData>>

  • Parameters

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

    Returns (() => void)

      • (): void
      • Returns void

  • Parameters

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

    Returns (() => void)

      • (): void
      • Returns void

  • Type Parameters

    • T = any
    • TVariables extends OperationVariables = OperationVariables

    Parameters

    Returns Promise<ApolloQueryResult<T>>

  • Parameters

    • Optional includeStandby: boolean

    Returns Promise<ApolloQueryResult<any>[]>

  • Type Parameters

    • T = any
    • TVariables = OperationVariables

    Parameters

    • options: Fragment<TVariables, T>
    • Optional optimistic: boolean

    Returns T

  • Type Parameters

    • T = any
    • TVariables = OperationVariables

    Parameters

    • options: Query<TVariables, T>
    • Optional optimistic: boolean

    Returns T

  • Type Parameters

    • TCache extends ApolloCache<any> = ApolloCache<T>
    • TResult = Promise<ApolloQueryResult<any>>

    Parameters

    Returns RefetchQueriesResult<TResult>

  • Returns Promise<ApolloQueryResult<any>[]>

  • Parameters

    • serializedState: T

    Returns ApolloCache<T>

  • Parameters

    • newLink: ApolloLink

    Returns void

  • Parameters

    • fragmentMatcher: FragmentMatcher

    Returns void

  • Parameters

    • resolvers: Resolvers | Resolvers[]

    Returns void

  • Returns void

  • Type Parameters

    • T = any
    • TVariables extends OperationVariables = OperationVariables

    Parameters

    Returns Observable<FetchResult<T>>

  • Type Parameters

    • T = any
    • TVariables extends OperationVariables = OperationVariables

    Parameters

    Returns ObservableQuery<T, TVariables>

  • Type Parameters

    • TData = any
    • TVariables = OperationVariables

    Parameters

    Returns Reference

  • Type Parameters

    • TData = any
    • TVariables = OperationVariables

    Parameters

    Returns Reference