UNPKG

3.91 kBTypeScriptView Raw
1import { ApolloLink, FetchResult, GraphQLRequest } from 'apollo-link';
2import { ExecutionResult, DocumentNode } from 'graphql';
3import { ApolloCache, DataProxy } from 'apollo-cache';
4import { QueryManager } from './core/QueryManager';
5import { ApolloQueryResult, OperationVariables, Resolvers } from './core/types';
6import { ObservableQuery } from './core/ObservableQuery';
7import { FragmentMatcher } from './core/LocalState';
8import { Observable } from './util/Observable';
9import { QueryOptions, WatchQueryOptions, SubscriptionOptions, MutationOptions } from './core/watchQueryOptions';
10import { DataStore } from './data/store';
11export interface DefaultOptions {
12 watchQuery?: Partial<WatchQueryOptions>;
13 query?: Partial<QueryOptions>;
14 mutate?: Partial<MutationOptions>;
15}
16export declare type ApolloClientOptions<TCacheShape> = {
17 link?: ApolloLink;
18 cache: ApolloCache<TCacheShape>;
19 ssrForceFetchDelay?: number;
20 ssrMode?: boolean;
21 connectToDevTools?: boolean;
22 queryDeduplication?: boolean;
23 defaultOptions?: DefaultOptions;
24 assumeImmutableResults?: boolean;
25 resolvers?: Resolvers | Resolvers[];
26 typeDefs?: string | string[] | DocumentNode | DocumentNode[];
27 fragmentMatcher?: FragmentMatcher;
28 name?: string;
29 version?: string;
30};
31export default class ApolloClient<TCacheShape> implements DataProxy {
32 link: ApolloLink;
33 store: DataStore<TCacheShape>;
34 cache: ApolloCache<TCacheShape>;
35 readonly queryManager: QueryManager<TCacheShape>;
36 disableNetworkFetches: boolean;
37 version: string;
38 queryDeduplication: boolean;
39 defaultOptions: DefaultOptions;
40 readonly typeDefs: ApolloClientOptions<TCacheShape>['typeDefs'];
41 private devToolsHookCb;
42 private resetStoreCallbacks;
43 private clearStoreCallbacks;
44 private localState;
45 constructor(options: ApolloClientOptions<TCacheShape>);
46 stop(): void;
47 watchQuery<T = any, TVariables = OperationVariables>(options: WatchQueryOptions<TVariables>): ObservableQuery<T, TVariables>;
48 query<T = any, TVariables = OperationVariables>(options: QueryOptions<TVariables>): Promise<ApolloQueryResult<T>>;
49 mutate<T = any, TVariables = OperationVariables>(options: MutationOptions<T, TVariables>): Promise<FetchResult<T>>;
50 subscribe<T = any, TVariables = OperationVariables>(options: SubscriptionOptions<TVariables>): Observable<FetchResult<T>>;
51 readQuery<T = any, TVariables = OperationVariables>(options: DataProxy.Query<TVariables>, optimistic?: boolean): T | null;
52 readFragment<T = any, TVariables = OperationVariables>(options: DataProxy.Fragment<TVariables>, optimistic?: boolean): T | null;
53 writeQuery<TData = any, TVariables = OperationVariables>(options: DataProxy.WriteQueryOptions<TData, TVariables>): void;
54 writeFragment<TData = any, TVariables = OperationVariables>(options: DataProxy.WriteFragmentOptions<TData, TVariables>): void;
55 writeData<TData = any>(options: DataProxy.WriteDataOptions<TData>): void;
56 __actionHookForDevTools(cb: () => any): void;
57 __requestRaw(payload: GraphQLRequest): Observable<ExecutionResult>;
58 initQueryManager(): QueryManager<TCacheShape>;
59 resetStore(): Promise<ApolloQueryResult<any>[] | null>;
60 clearStore(): Promise<any[]>;
61 onResetStore(cb: () => Promise<any>): () => void;
62 onClearStore(cb: () => Promise<any>): () => void;
63 reFetchObservableQueries(includeStandby?: boolean): Promise<ApolloQueryResult<any>[]>;
64 extract(optimistic?: boolean): TCacheShape;
65 restore(serializedState: TCacheShape): ApolloCache<TCacheShape>;
66 addResolvers(resolvers: Resolvers | Resolvers[]): void;
67 setResolvers(resolvers: Resolvers | Resolvers[]): void;
68 getResolvers(): Resolvers;
69 setLocalStateFragmentMatcher(fragmentMatcher: FragmentMatcher): void;
70}
71//# sourceMappingURL=ApolloClient.d.ts.map
\No newline at end of file