UNPKG

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