Skip to content

Commit 9408876

Browse files
committed
remove all @since tags from React hooks
1 parent 9b6d831 commit 9408876

File tree

10 files changed

+0
-17
lines changed

10 files changed

+0
-17
lines changed

src/react/hooks/useApolloClient.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ import { getApolloContext } from "../context/ApolloContext.js";
1717
* }
1818
* ```
1919
*
20-
* @since 3.0.0
2120
* @returns The `ApolloClient` instance being used by the application.
2221
*/
2322
export function useApolloClient(override?: ApolloClient): ApolloClient {

src/react/hooks/useLazyQuery.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,6 @@ const EAGER_METHODS = [
281281
* return <h1>Hello {data.greeting.message}!</h1>;
282282
* }
283283
* ```
284-
* @since 3.0.0
285284
*
286285
* @param query - A GraphQL query document parsed into an AST by `gql`.
287286
* @param options - Default options to control how the query is executed.

src/react/hooks/useLoadableQuery.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,6 @@ export declare namespace useLoadableQuery {
155155
* }
156156
* ```
157157
*
158-
* @since 3.9.0
159158
* @param query - A GraphQL query document parsed into an AST by `gql`.
160159
* @param options - Options to control how the query is executed.
161160
* @returns A tuple in the form of `[loadQuery, queryRef, handlers]`

src/react/hooks/useMutation.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,6 @@ export declare namespace useMutation {
220220
* );
221221
* }
222222
* ```
223-
* @since 3.0.0
224223
* @param mutation - A GraphQL mutation document parsed into an AST by `gql`.
225224
* @param options - Options to control how the mutation is executed.
226225
* @returns A tuple in the form of `[mutate, result]`

src/react/hooks/useQuery.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,6 @@ interface InternalState<TData, TVariables extends OperationVariables> {
263263
* return <h1>Hello {data.greeting.message}!</h1>;
264264
* }
265265
* ```
266-
* @since 3.0.0
267266
* @param query - A GraphQL query document parsed into an AST by `gql`.
268267
* @param options - Options to control how the query is executed.
269268
* @returns Query result object

src/react/hooks/useQueryRefHandlers.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,6 @@ export declare namespace useQueryRefHandlers {
6464
* // ...
6565
* }
6666
* ```
67-
* @since 3.9.0
6867
* @param queryRef - A `QueryRef` returned from `useBackgroundQuery`, `useLoadableQuery`, or `createQueryPreloader`.
6968
*/
7069
export function useQueryRefHandlers<

src/react/hooks/useReactiveVar.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ import { useSyncExternalStore } from "./useSyncExternalStore.js";
1717
* // ...
1818
* }
1919
* ```
20-
* @since 3.2.0
2120
* @param rv - A reactive variable.
2221
* @returns The current value of the reactive variable.
2322
*/

src/react/hooks/useSubscription.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,6 @@ export declare namespace useSubscription {
205205
*
206206
* Now, the first message will be added to the `accumulatedData` array since `onData` is called _before_ the component re-renders. React 18 automatic batching is still in effect and results in a single re-render, but with `onData` we can guarantee each message received after the component mounts is added to `accumulatedData`.
207207
*
208-
* @since 3.0.0
209208
* @param subscription - A GraphQL subscription document parsed into an AST by `gql`.
210209
* @param options - Options to control how the subscription is executed.
211210
* @returns Query result object

src/react/query-preloader/createQueryPreloader.ts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,6 @@ export interface PreloadQueryFunction {
141141
* // ...
142142
* }
143143
* ```
144-
*
145-
* @since 4.0.0
146144
*/
147145
toPromise<TQueryRef extends PreloadedQueryRef<any, any, any>>(
148146
queryRef: TQueryRef
@@ -165,7 +163,6 @@ export interface PreloadQueryFunction {
165163
* ```js
166164
* const preloadQuery = createQueryPreloader(client);
167165
* ```
168-
* @since 3.9.0
169166
*/
170167
export function createQueryPreloader(
171168
client: ApolloClient

src/react/types/types.documentation.ts

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -551,22 +551,16 @@ export interface SubscriptionOptionsDocumentation {
551551

552552
/**
553553
* Allows the registration of a callback function that will be triggered each time the `useSubscription` Hook / `Subscription` component completes the subscription.
554-
*
555-
* @since 3.7.0
556554
*/
557555
onComplete: unknown;
558556

559557
/**
560558
* Allows the registration of a callback function that will be triggered each time the `useSubscription` Hook / `Subscription` component receives data. The callback `options` object param consists of the current Apollo Client instance in `client`, and the received subscription data in `data`.
561-
*
562-
* @since 3.7.0
563559
*/
564560
onData: unknown;
565561

566562
/**
567563
* Allows the registration of a callback function that will be triggered each time the `useSubscription` Hook / `Subscription` component receives an error.
568-
*
569-
* @since 3.7.0
570564
*/
571565
onError: unknown;
572566
}

0 commit comments

Comments
 (0)