Skip to content

Commit 4adf124

Browse files
jerelmillerphryneas
jerelmiller
authored and
phryneas
committed
Update api report
1 parent 56547bc commit 4adf124

27 files changed

+461
-450
lines changed

‎.api-reports/api-report-core.api.md‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ export abstract class ApolloCache<TSerialized> implements DataProxy {
9393
}
9494

9595
// @public
96-
export class ApolloClient<TCacheShape> implements DataProxy {
96+
export class ApolloClient<TCacheShape = any> implements DataProxy {
9797
// (undocumented)
9898
__actionHookForDevTools(cb: () => any): void;
9999
constructor(options: ApolloClientOptions<TCacheShape>);
@@ -137,9 +137,9 @@ export class ApolloClient<TCacheShape> implements DataProxy {
137137
queryDeduplication: boolean;
138138
readFragment<T = any, TVariables = OperationVariables>(options: DataProxy.Fragment<TVariables, T>, optimistic?: boolean): Unmasked<T> | null;
139139
readQuery<T = any, TVariables = OperationVariables>(options: DataProxy.Query<TVariables, T>, optimistic?: boolean): Unmasked<T> | null;
140-
reFetchObservableQueries(includeStandby?: boolean): Promise<ApolloQueryResult<any>[]>;
141-
refetchQueries<TCache extends ApolloCache<any> = ApolloCache<TCacheShape>, TResult = Promise<ApolloQueryResult<any>>>(options: RefetchQueriesOptions<TCache, TResult>): RefetchQueriesResult<TResult>;
142-
resetStore(): Promise<ApolloQueryResult<any>[] | null>;
140+
reFetchObservableQueries(includeStandby?: boolean): Promise<InteropApolloQueryResult<any>[]>;
141+
refetchQueries<TCache extends ApolloCache<any> = ApolloCache<TCacheShape>, TResult = Promise<InteropApolloQueryResult<any>>>(options: RefetchQueriesOptions<TCache, TResult>): RefetchQueriesResult<TResult>;
142+
resetStore(): Promise<InteropApolloQueryResult<any>[] | null>;
143143
restore(serializedState: TCacheShape): ApolloCache<TCacheShape>;
144144
setLink(newLink: ApolloLink): void;
145145
// @deprecated
@@ -255,13 +255,13 @@ export class ApolloLink {
255255
getMemoryInternals?: () => unknown;
256256
// @internal
257257
readonly left?: ApolloLink;
258-
// (undocumented)
258+
// @deprecated (undocumented)
259259
protected onError(error: any, observer?: Observer<FetchResult>): false | void;
260260
// (undocumented)
261261
request(operation: Operation, forward?: NextLink): Observable<FetchResult> | null;
262262
// @internal
263263
readonly right?: ApolloLink;
264-
// (undocumented)
264+
// @deprecated (undocumented)
265265
setOnError(fn: ApolloLink["onError"]): this;
266266
// (undocumented)
267267
static split(test: (op: Operation) => boolean, left: ApolloLink | RequestHandler, right?: ApolloLink | RequestHandler): ApolloLink;
@@ -811,7 +811,7 @@ export const execute: typeof ApolloLink.execute;
811811

812812
// Warning: (ae-forgotten-export) The symbol "ExecutionPatchResultBase" needs to be exported by the entry point index.d.ts
813813
//
814-
// @public (undocumented)
814+
// @public @deprecated (undocumented)
815815
export interface ExecutionPatchIncrementalResult<TData = Record<string, any>, TExtensions = Record<string, any>> extends ExecutionPatchResultBase {
816816
// (undocumented)
817817
data?: never;
@@ -823,7 +823,7 @@ export interface ExecutionPatchIncrementalResult<TData = Record<string, any>, TE
823823
incremental?: IncrementalPayload<TData, TExtensions>[];
824824
}
825825

826-
// @public (undocumented)
826+
// @public @deprecated (undocumented)
827827
export interface ExecutionPatchInitialResult<TData = Record<string, any>, TExtensions = Record<string, any>> extends ExecutionPatchResultBase {
828828
// (undocumented)
829829
data: TData | null | undefined;
@@ -835,7 +835,7 @@ export interface ExecutionPatchInitialResult<TData = Record<string, any>, TExten
835835
incremental?: never;
836836
}
837837

838-
// @public (undocumented)
838+
// @public @deprecated (undocumented)
839839
export type ExecutionPatchResult<TData = Record<string, any>, TExtensions = Record<string, any>> = ExecutionPatchInitialResult<TData, TExtensions> | ExecutionPatchIncrementalResult<TData, TExtensions>;
840840

841841
// @public (undocumented)
@@ -993,10 +993,10 @@ TData
993993
// @public (undocumented)
994994
export const from: typeof ApolloLink.from;
995995

996-
// @public (undocumented)
996+
// @public @deprecated (undocumented)
997997
export function fromError<T>(errorValue: any): Observable<T>;
998998

999-
// @public (undocumented)
999+
// @public @deprecated (undocumented)
10001000
export function fromPromise<T>(promise: Promise<T>): Observable<T>;
10011001

10021002
// @internal
@@ -1142,7 +1142,7 @@ interface IgnoreModifier {
11421142
// @public (undocumented)
11431143
const _ignoreModifier: unique symbol;
11441144

1145-
// @public (undocumented)
1145+
// @public @deprecated (undocumented)
11461146
export interface IncrementalPayload<TData, TExtensions> {
11471147
// (undocumented)
11481148
data: TData | null;
@@ -1253,7 +1253,7 @@ export interface InternalRefetchQueriesOptions<TCache extends ApolloCache<any>,
12531253
}
12541254

12551255
// @public (undocumented)
1256-
export type InternalRefetchQueriesResult<TResult> = TResult extends boolean ? Promise<ApolloQueryResult<any>> : TResult;
1256+
export type InternalRefetchQueriesResult<TResult> = TResult extends boolean ? Promise<InteropApolloQueryResult<any>> : TResult;
12571257

12581258
// @public (undocumented)
12591259
export type InternalRefetchQueryDescriptor = RefetchQueryDescriptor | QueryOptions;
@@ -1335,7 +1335,7 @@ const _invalidateModifier: unique symbol;
13351335
// @public (undocumented)
13361336
type IsAny<T> = 0 extends 1 & T ? true : false;
13371337

1338-
// @public (undocumented)
1338+
// @public @deprecated (undocumented)
13391339
export function isApolloError(err: Error): err is ApolloError;
13401340

13411341
// @public
@@ -1646,7 +1646,7 @@ export type MutationQueryReducersMap<T = {
16461646

16471647
// Warning: (ae-forgotten-export) The symbol "MutationBaseOptions" needs to be exported by the entry point index.d.ts
16481648
//
1649-
// @public (undocumented)
1649+
// @public @deprecated (undocumented)
16501650
interface MutationSharedOptions<TData = any, TVariables = OperationVariables, TContext = DefaultContext, TCache extends ApolloCache<any> = ApolloCache<any>> extends MutationBaseOptions<TData, TVariables, TContext, TCache> {
16511651
fetchPolicy?: MutationFetchPolicy;
16521652
keepRootFields?: boolean;
@@ -1767,9 +1767,9 @@ export class ObservableQuery<TData = any, TVariables extends OperationVariables
17671767
}): Promise<InteropApolloQueryResult<MaybeMasked<TFetchData>>>;
17681768
// (undocumented)
17691769
getCurrentResult(saveAsLastResult?: boolean): ApolloQueryResult<MaybeMasked<TData>>;
1770-
// (undocumented)
1770+
// @deprecated (undocumented)
17711771
getLastError(variablesMustMatch?: boolean): ApolloError | undefined;
1772-
// (undocumented)
1772+
// @deprecated (undocumented)
17731773
getLastResult(variablesMustMatch?: boolean): ApolloQueryResult<TData> | undefined;
17741774
// (undocumented)
17751775
hasObservers(): boolean;
@@ -1781,7 +1781,7 @@ export class ObservableQuery<TData = any, TVariables extends OperationVariables
17811781
readonly options: WatchQueryOptions<TVariables, TData>;
17821782
// (undocumented)
17831783
get query(): TypedDocumentNode<TData, TVariables>;
1784-
// (undocumented)
1784+
// @deprecated (undocumented)
17851785
readonly queryId: string;
17861786
// (undocumented)
17871787
readonly queryName?: string;
@@ -1794,21 +1794,21 @@ export class ObservableQuery<TData = any, TVariables extends OperationVariables
17941794
reobserveAsConcast(newOptions?: Partial<WatchQueryOptions<TVariables, TData>>, newNetworkStatus?: NetworkStatus): Concast<ApolloQueryResult<TData>>;
17951795
// @internal (undocumented)
17961796
resetDiff(): void;
1797-
// (undocumented)
1797+
// @deprecated (undocumented)
17981798
resetLastResults(): void;
17991799
// @internal (undocumented)
18001800
protected resetNotifications(): void;
1801-
// (undocumented)
1801+
// @deprecated (undocumented)
18021802
resetQueryStoreErrors(): void;
18031803
// (undocumented)
18041804
resubscribeAfterError(onNext: (value: ApolloQueryResult<MaybeMasked<TData>>) => void, onError?: (error: any) => void, onComplete?: () => void): ObservableSubscription;
18051805
// (undocumented)
18061806
resubscribeAfterError(observer: Observer<ApolloQueryResult<TData>>): ObservableSubscription;
1807-
// (undocumented)
1807+
// @deprecated (undocumented)
18081808
result(): Promise<ApolloQueryResult<MaybeMasked<TData>>>;
18091809
// @internal (undocumented)
18101810
protected scheduleNotify(): void;
1811-
// (undocumented)
1811+
// @deprecated (undocumented)
18121812
setOptions(newOptions: Partial<WatchQueryOptions<TVariables, TData>>): Promise<InteropApolloQueryResult<MaybeMasked<TData>>>;
18131813
setVariables(variables: TVariables): Promise<InteropApolloQueryResult<MaybeMasked<TData>> | void>;
18141814
// (undocumented)
@@ -1862,7 +1862,7 @@ type OptionsUnion<TData, TVariables extends OperationVariables, TContext> = Watc
18621862
// @public (undocumented)
18631863
export function parseAndCheckHttpResponse(operations: Operation | Operation[]): (response: Response) => Promise<any>;
18641864

1865-
// @public (undocumented)
1865+
// @public @deprecated (undocumented)
18661866
export type Path = ReadonlyArray<string | number>;
18671867

18681868
// @public (undocumented)
@@ -2230,7 +2230,7 @@ export interface RefetchQueriesOptions<TCache extends ApolloCache<any>, TResult>
22302230
// Warning: (ae-forgotten-export) The symbol "IsStrictlyAny" needs to be exported by the entry point index.d.ts
22312231
//
22322232
// @public (undocumented)
2233-
export type RefetchQueriesPromiseResults<TResult> = IsStrictlyAny<TResult> extends true ? any[] : TResult extends boolean ? ApolloQueryResult<any>[] : TResult extends PromiseLike<infer U> ? U[] : TResult[];
2233+
export type RefetchQueriesPromiseResults<TResult> = IsStrictlyAny<TResult> extends true ? any[] : TResult extends boolean ? InteropApolloQueryResult<any>[] : TResult extends PromiseLike<infer U> ? U[] : TResult[];
22342234

22352235
// @public (undocumented)
22362236
export interface RefetchQueriesResult<TResult> extends Promise<RefetchQueriesPromiseResults<TResult>> {
@@ -2439,10 +2439,10 @@ export interface SubscriptionOptions<TVariables = OperationVariables, TData = an
24392439
// @public (undocumented)
24402440
type takeOneFromUnion<T> = unionToIntersection<T extends T ? (x: T) => 0 : never> extends ((x: infer U) => 0) ? U : never;
24412441

2442-
// @public (undocumented)
2442+
// @public @deprecated (undocumented)
24432443
export const throwServerError: (response: Response, result: any, message: string) => never;
24442444

2445-
// @public (undocumented)
2445+
// @public @deprecated (undocumented)
24462446
export function toPromise<R>(observable: Observable<R>): Promise<R>;
24472447

24482448
// @public (undocumented)
@@ -2611,8 +2611,8 @@ interface WriteContext extends ReadMergeModifyContext {
26112611
// src/cache/inmemory/policies.ts:162:3 - (ae-forgotten-export) The symbol "KeySpecifier" needs to be exported by the entry point index.d.ts
26122612
// src/cache/inmemory/policies.ts:162:3 - (ae-forgotten-export) The symbol "KeyArgsFunction" needs to be exported by the entry point index.d.ts
26132613
// src/cache/inmemory/types.ts:139:3 - (ae-forgotten-export) The symbol "KeyFieldsFunction" needs to be exported by the entry point index.d.ts
2614-
// src/core/ObservableQuery.ts:130:5 - (ae-forgotten-export) The symbol "QueryManager" needs to be exported by the entry point index.d.ts
2615-
// src/core/ObservableQuery.ts:131:5 - (ae-forgotten-export) The symbol "QueryInfo" needs to be exported by the entry point index.d.ts
2614+
// src/core/ObservableQuery.ts:143:5 - (ae-forgotten-export) The symbol "QueryManager" needs to be exported by the entry point index.d.ts
2615+
// src/core/ObservableQuery.ts:144:5 - (ae-forgotten-export) The symbol "QueryInfo" needs to be exported by the entry point index.d.ts
26162616
// src/core/QueryManager.ts:160:5 - (ae-forgotten-export) The symbol "MutationStoreValue" needs to be exported by the entry point index.d.ts
26172617
// src/core/QueryManager.ts:415:7 - (ae-forgotten-export) The symbol "UpdateQueries" needs to be exported by the entry point index.d.ts
26182618
// src/link/http/selectHttpOptionsAndBody.ts:128:32 - (ae-forgotten-export) The symbol "HttpQueryOptions" needs to be exported by the entry point index.d.ts

‎.api-reports/api-report-errors.api.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ interface DefaultContext extends Record<string, any> {
5656

5757
// Warning: (ae-forgotten-export) The symbol "ExecutionPatchResultBase" needs to be exported by the entry point index.d.ts
5858
//
59-
// @public (undocumented)
59+
// @public @deprecated (undocumented)
6060
interface ExecutionPatchIncrementalResult<TData = Record<string, any>, TExtensions = Record<string, any>> extends ExecutionPatchResultBase {
6161
// (undocumented)
6262
data?: never;
@@ -70,7 +70,7 @@ interface ExecutionPatchIncrementalResult<TData = Record<string, any>, TExtensio
7070
incremental?: IncrementalPayload<TData, TExtensions>[];
7171
}
7272

73-
// @public (undocumented)
73+
// @public @deprecated (undocumented)
7474
interface ExecutionPatchInitialResult<TData = Record<string, any>, TExtensions = Record<string, any>> extends ExecutionPatchResultBase {
7575
// (undocumented)
7676
data: TData | null | undefined;
@@ -85,7 +85,7 @@ interface ExecutionPatchInitialResult<TData = Record<string, any>, TExtensions =
8585
// Warning: (ae-forgotten-export) The symbol "ExecutionPatchInitialResult" needs to be exported by the entry point index.d.ts
8686
// Warning: (ae-forgotten-export) The symbol "ExecutionPatchIncrementalResult" needs to be exported by the entry point index.d.ts
8787
//
88-
// @public (undocumented)
88+
// @public @deprecated (undocumented)
8989
type ExecutionPatchResult<TData = Record<string, any>, TExtensions = Record<string, any>> = ExecutionPatchInitialResult<TData, TExtensions> | ExecutionPatchIncrementalResult<TData, TExtensions>;
9090

9191
// @public (undocumented)
@@ -115,7 +115,7 @@ export type GraphQLErrors = ReadonlyArray<GraphQLError>;
115115
// @public (undocumented)
116116
export function graphQLResultHasProtocolErrors<T>(result: FetchResult<T>): result is FetchResultWithSymbolExtensions<T>;
117117

118-
// @public (undocumented)
118+
// @public @deprecated (undocumented)
119119
interface IncrementalPayload<TData, TExtensions> {
120120
// (undocumented)
121121
data: TData | null;
@@ -131,13 +131,13 @@ interface IncrementalPayload<TData, TExtensions> {
131131
path: Path;
132132
}
133133

134-
// @public (undocumented)
134+
// @public @deprecated (undocumented)
135135
export function isApolloError(err: Error): err is ApolloError;
136136

137137
// @public (undocumented)
138138
export type NetworkError = Error | ServerParseError | ServerError | null;
139139

140-
// @public (undocumented)
140+
// @public @deprecated (undocumented)
141141
type Path = ReadonlyArray<string | number>;
142142

143143
// @public (undocumented)

‎.api-reports/api-report-link_batch-http.api.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ class ApolloLink {
3232
getMemoryInternals?: () => unknown;
3333
// @internal
3434
readonly left?: ApolloLink;
35-
// (undocumented)
35+
// @deprecated (undocumented)
3636
protected onError(error: any, observer?: Observer<FetchResult>): false | void;
3737
// Warning: (ae-forgotten-export) The symbol "NextLink" needs to be exported by the entry point index.d.ts
3838
//
3939
// (undocumented)
4040
request(operation: Operation, forward?: NextLink): Observable<FetchResult> | null;
4141
// @internal
4242
readonly right?: ApolloLink;
43-
// (undocumented)
43+
// @deprecated (undocumented)
4444
setOnError(fn: ApolloLink["onError"]): this;
4545
// Warning: (ae-forgotten-export) The symbol "Operation" needs to be exported by the entry point index.d.ts
4646
//
@@ -97,7 +97,7 @@ interface DefaultContext extends Record<string, any> {
9797

9898
// Warning: (ae-forgotten-export) The symbol "ExecutionPatchResultBase" needs to be exported by the entry point index.d.ts
9999
//
100-
// @public (undocumented)
100+
// @public @deprecated (undocumented)
101101
interface ExecutionPatchIncrementalResult<TData = Record<string, any>, TExtensions = Record<string, any>> extends ExecutionPatchResultBase {
102102
// (undocumented)
103103
data?: never;
@@ -111,7 +111,7 @@ interface ExecutionPatchIncrementalResult<TData = Record<string, any>, TExtensio
111111
incremental?: IncrementalPayload<TData, TExtensions>[];
112112
}
113113

114-
// @public (undocumented)
114+
// @public @deprecated (undocumented)
115115
interface ExecutionPatchInitialResult<TData = Record<string, any>, TExtensions = Record<string, any>> extends ExecutionPatchResultBase {
116116
// (undocumented)
117117
data: TData | null | undefined;
@@ -126,7 +126,7 @@ interface ExecutionPatchInitialResult<TData = Record<string, any>, TExtensions =
126126
// Warning: (ae-forgotten-export) The symbol "ExecutionPatchInitialResult" needs to be exported by the entry point index.d.ts
127127
// Warning: (ae-forgotten-export) The symbol "ExecutionPatchIncrementalResult" needs to be exported by the entry point index.d.ts
128128
//
129-
// @public (undocumented)
129+
// @public @deprecated (undocumented)
130130
type ExecutionPatchResult<TData = Record<string, any>, TExtensions = Record<string, any>> = ExecutionPatchInitialResult<TData, TExtensions> | ExecutionPatchIncrementalResult<TData, TExtensions>;
131131

132132
// @public (undocumented)
@@ -173,7 +173,7 @@ interface HttpOptions {
173173
useGETForQueries?: boolean;
174174
}
175175

176-
// @public (undocumented)
176+
// @public @deprecated (undocumented)
177177
interface IncrementalPayload<TData, TExtensions> {
178178
// (undocumented)
179179
data: TData | null;
@@ -211,7 +211,7 @@ interface Operation {
211211
variables: Record<string, any>;
212212
}
213213

214-
// @public (undocumented)
214+
// @public @deprecated (undocumented)
215215
type Path = ReadonlyArray<string | number>;
216216

217217
// @public (undocumented)

‎.api-reports/api-report-link_batch.api.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@ class ApolloLink {
3131
getMemoryInternals?: () => unknown;
3232
// @internal
3333
readonly left?: ApolloLink;
34-
// (undocumented)
34+
// @deprecated (undocumented)
3535
protected onError(error: any, observer?: Observer<FetchResult>): false | void;
3636
// Warning: (ae-forgotten-export) The symbol "NextLink" needs to be exported by the entry point index.d.ts
3737
//
3838
// (undocumented)
3939
request(operation: Operation, forward?: NextLink): Observable<FetchResult> | null;
4040
// @internal
4141
readonly right?: ApolloLink;
42-
// (undocumented)
42+
// @deprecated (undocumented)
4343
setOnError(fn: ApolloLink["onError"]): this;
4444
// Warning: (ae-forgotten-export) The symbol "Operation" needs to be exported by the entry point index.d.ts
4545
//
@@ -87,7 +87,7 @@ interface DefaultContext extends Record<string, any> {
8787

8888
// Warning: (ae-forgotten-export) The symbol "ExecutionPatchResultBase" needs to be exported by the entry point index.d.ts
8989
//
90-
// @public (undocumented)
90+
// @public @deprecated (undocumented)
9191
interface ExecutionPatchIncrementalResult<TData = Record<string, any>, TExtensions = Record<string, any>> extends ExecutionPatchResultBase {
9292
// (undocumented)
9393
data?: never;
@@ -101,7 +101,7 @@ interface ExecutionPatchIncrementalResult<TData = Record<string, any>, TExtensio
101101
incremental?: IncrementalPayload<TData, TExtensions>[];
102102
}
103103

104-
// @public (undocumented)
104+
// @public @deprecated (undocumented)
105105
interface ExecutionPatchInitialResult<TData = Record<string, any>, TExtensions = Record<string, any>> extends ExecutionPatchResultBase {
106106
// (undocumented)
107107
data: TData | null | undefined;
@@ -116,7 +116,7 @@ interface ExecutionPatchInitialResult<TData = Record<string, any>, TExtensions =
116116
// Warning: (ae-forgotten-export) The symbol "ExecutionPatchInitialResult" needs to be exported by the entry point index.d.ts
117117
// Warning: (ae-forgotten-export) The symbol "ExecutionPatchIncrementalResult" needs to be exported by the entry point index.d.ts
118118
//
119-
// @public (undocumented)
119+
// @public @deprecated (undocumented)
120120
type ExecutionPatchResult<TData = Record<string, any>, TExtensions = Record<string, any>> = ExecutionPatchInitialResult<TData, TExtensions> | ExecutionPatchIncrementalResult<TData, TExtensions>;
121121

122122
// @public (undocumented)
@@ -147,7 +147,7 @@ interface GraphQLRequest<TVariables = Record<string, any>> {
147147
variables?: TVariables;
148148
}
149149

150-
// @public (undocumented)
150+
// @public @deprecated (undocumented)
151151
interface IncrementalPayload<TData, TExtensions> {
152152
// (undocumented)
153153
data: TData | null;
@@ -200,7 +200,7 @@ export class OperationBatcher {
200200
enqueueRequest(request: BatchableRequest): Observable<FetchResult>;
201201
}
202202

203-
// @public (undocumented)
203+
// @public @deprecated (undocumented)
204204
type Path = ReadonlyArray<string | number>;
205205

206206
// @public (undocumented)

0 commit comments

Comments
 (0)