Skip to content

Commit 452ae00

Browse files
committed
more removal annotations
1 parent 6265da5 commit 452ae00

1 file changed

Lines changed: 70 additions & 24 deletions

File tree

src/removals.ts

Lines changed: 70 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -24,30 +24,72 @@ export declare namespace Removals {
2424
* Use the hooks exported from the `@apollo/client/react` package instead.
2525
*/
2626
export type renderProp = never;
27+
/**
28+
* @deprecated The export `{{name}}` has been removed from Apollo Client 4.0.
29+
*
30+
* Error handling has been overhauled as a whole.
31+
*/
32+
export type errors = never;
33+
/**
34+
* @deprecated The export `{{name}}` has been removed from Apollo Client 4.0.
35+
*
36+
* The Observable implementation of Apollo Client has been moved from `zen-observable` to `rxjs`.
37+
*/
38+
export type rxjs = never;
39+
/**
40+
* @deprecated The export `{{name}}` has been removed from Apollo Client 4.0.
41+
*
42+
* This export was an implementation detail of {{of}} and is no longer available.
43+
*/
44+
export type implementationDetail = never;
45+
/**
46+
* @deprecated The utility `{{name}}` has been removed from Apollo Client 4.0.
47+
*
48+
* It was an implementation detail that is no longer necessary and has been removed without replacement.
49+
*/
50+
export type utility = never;
51+
/**
52+
* @deprecated The export `{{name}}` has been removed from Apollo Client 4.0.
53+
*
54+
* The testing utilities have moved into their own package, [@apollo/graphql-testing-library](https://github.com/apollographql/graphql-testing-library).
55+
*/
56+
export type testingLibrary = never;
57+
/**
58+
* @deprecated The export `{{name}}` has been removed from Apollo Client 4.0.
59+
*
60+
* This export is considered internal and is no longer exposed.
61+
*/
62+
export type internal = never;
2763
}
2864

2965
/**
30-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"ApolloConsumer"} }
66+
* {@inheritDoc @apollo/client/removals!Removals.HOC:type }
3167
*/
3268
export declare const ApolloConsumer: never;
3369

3470
/**
35-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"ApolloError"} }
71+
* {@inheritDoc @apollo/client/removals!Removals.errors:type {"name":"ApolloError"} }
3672
*/
3773
export declare const ApolloError: never;
3874

3975
/**
40-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"Concast"} }
76+
* {@inheritDoc @apollo/client/removals!Removals.rxjs:type {"name":"Concast"} }
77+
*
78+
* Instead of `Concast`, look into the `rxjs` [`BehaviorSubject`](https://rxjs.dev/api/index/class/BehaviorSubject) api.
4179
*/
4280
export declare const Concast: never;
4381

4482
/**
45-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"DataProxy"} }
83+
* {@inheritDoc @apollo/client/removals!Removals.removedType:type {"name":"DataProxy"} }
84+
*
85+
* You can find the types that were previously available in the `DataProxy` namespace either in the `ApolloClient` namespace or the `Cache` namespace.
4686
*/
4787
export declare const DataProxy: never;
4888

4989
/**
50-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"DocumentType"} }
90+
* @deprecated The `DocumentType` enum has been removed from Apollo Client 4.0, along with the `parser` API exported from `@apollo/client/react/parser`.
91+
*
92+
* This API was mostly an implementation detail and has been removed without replacement.
5193
*/
5294
export declare const DocumentType: never;
5395

@@ -57,17 +99,17 @@ export declare const DocumentType: never;
5799
export declare const Mutation: never;
58100

59101
/**
60-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"ObservableSubscription"} }
102+
* {@inheritDoc @apollo/client/removals!Removals.rxjs:type {"name":"ObservableSubscription"} }
61103
*/
62104
export declare const ObservableSubscription: never;
63105

64106
/**
65-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"Observer"} }
107+
* {@inheritDoc @apollo/client/removals!Removals.rxjs:type {"name":"Observer"} }
66108
*/
67109
export declare const Observer: never;
68110

69111
/**
70-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"OperationBatcher"} }
112+
* {@inheritDoc @apollo/client/removals!Removals.implementationDetail:type {"name":"OperationBatcher", "of": "`BatchLink`"} }
71113
*/
72114
export declare const OperationBatcher: never;
73115

@@ -77,87 +119,91 @@ export declare const OperationBatcher: never;
77119
export declare const Query: never;
78120

79121
/**
80-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"RenderPromises"} }
122+
* {@inheritDoc @apollo/client/removals!Removals.implementationDetail:type {"name":"RenderPromises", "of": "`getMarkupFromTree`"} }
81123
*/
82124
export declare const RenderPromises: never;
83125

84126
/**
85-
* {@inheritDoc @apollo/client/removals!Removals.renderProp:type }
127+
* {@inheritDoc @apollo/client/removals!Removals.rxjs:type {"name":"Subscription"} }
86128
*/
87129
export declare const Subscription: never;
88130

89131
/**
90-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"addNonReactiveToNamedFragments"} }
132+
* {@inheritDoc @apollo/client/removals!Removals.implementationDetail:type {"name":"addNonReactiveToNamedFragments", "of": "the internal `QueryManager` class"} }
91133
*/
92134
export declare const addNonReactiveToNamedFragments: never;
93135

94136
/**
95-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"asyncMap"} }
137+
* {@inheritDoc @apollo/client/removals!Removals.rxjs:type {"name":"asyncMap"} }
138+
*
139+
* Consider using the `rxjs` [`mergeMap`](https://rxjs.dev/api/operators/mergeMap) operator instead.
96140
*/
97141
export declare const asyncMap: never;
98142

99143
/**
100-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"buildQueryFromSelectionSet"} }
144+
* {@inheritDoc @apollo/client/removals!Removals.utility:type {"name":"buildQueryFromSelectionSet"} }
101145
*/
102146
export declare const buildQueryFromSelectionSet: never;
103147

104148
/**
105-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"canUseAsyncIteratorSymbol"} }
149+
* {@inheritDoc @apollo/client/removals!Removals.utility:type {"name":"canUseAsyncIteratorSymbol"} }
106150
*/
107151
export declare const canUseAsyncIteratorSymbol: never;
108152

109153
/**
110-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"canUseLayoutEffect"} }
154+
* {@inheritDoc @apollo/client/removals!Removals.utility:type {"name":"canUseLayoutEffect"} }
111155
*/
112156
export declare const canUseLayoutEffect: never;
113157

114158
/**
115-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"canUseSymbol"} }
159+
* {@inheritDoc @apollo/client/removals!Removals.utility:type {"name":"canUseSymbol"} }
116160
*/
117161
export declare const canUseSymbol: never;
118162

119163
/**
120-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"canUseWeakMap"} }
164+
* {@inheritDoc @apollo/client/removals!Removals.utility:type {"name":"canUseWeakMap"} }
121165
*/
122166
export declare const canUseWeakMap: never;
123167

124168
/**
125-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"canUseWeakSet"} }
169+
* {@inheritDoc @apollo/client/removals!Removals.utility:type {"name":"canUseWeakSet"} }
126170
*/
127171
export declare const canUseWeakSet: never;
128172

129173
/**
130174
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"createMockClient"} }
175+
*
176+
* Please create an `ApolloClient` instance with a `MockLink` manually instead.
131177
*/
132178
export declare const createMockClient: never;
133179

134180
/**
135-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"createSchemaFetch"} }
181+
* {@inheritDoc @apollo/client/removals!Removals.testingLibrary:type {"name":"createSchemaFetch"} }
136182
*/
137183
export declare const createSchemaFetch: never;
138184

139185
/**
140-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"createTestSchema"} }
186+
* {@inheritDoc @apollo/client/removals!Removals.testingLibrary:type {"name":"createTestSchema"} }
141187
*/
142188
export declare const createTestSchema: never;
143189

144190
/**
145-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"defaultCacheSizes"} }
191+
* {@inheritDoc @apollo/client/removals!Removals.internal:type {"name":"defaultCacheSizes"} }
146192
*/
147193
export declare const defaultCacheSizes: never;
148194

149195
/**
150-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"fixObservableSubclass"} }
196+
* {@inheritDoc @apollo/client/removals!Removals.implementationDetail:type {"name":"fixObservableSubclass","of":"ObservableQuery"} }
151197
*/
152198
export declare const fixObservableSubclass: never;
153199

154200
/**
155-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"fromError"} }
201+
* {@inheritDoc @apollo/client/removals!Removals.rxjs:type {"name":"fromError"} }
156202
*/
157203
export declare const fromError: never;
158204

159205
/**
160-
* {@inheritDoc @apollo/client/removals!Removals.removedValue:type {"name":"fromPromise"} }
206+
* {@inheritDoc @apollo/client/removals!Removals.rxjs:type {"name":"fromPromise"} }
161207
*/
162208
export declare const fromPromise: never;
163209

0 commit comments

Comments
 (0)