Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an explicit return type for useReadQuery #11297

Merged
merged 6 commits into from
Oct 17, 2023
Merged

Add an explicit return type for useReadQuery #11297

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6114c88
Add explicit return type for useReadQuery
jerelmiller Oct 16, 2023
399c77b
Add changeset
jerelmiller Oct 16, 2023
85b1b80
Add typedoc comments to UseReadQueryResult type
jerelmiller Oct 16, 2023
1c246dc
Update api report
jerelmiller Oct 16, 2023
3ff9299
Merge branch 'main' into jerel/use-read-query-result-type
jerelmiller Oct 17, 2023
a7700c9
Tweak changeset
jerelmiller Oct 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions .api-reports/api-report-react.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2101,11 +2101,17 @@ export function useQuery<TData = any, TVariables extends OperationVariables = Op
export function useReactiveVar<T>(rv: ReactiveVar<T>): T;

// @public (undocumented)
export function useReadQuery<TData>(queryRef: QueryReference<TData>): {
export function useReadQuery<TData>(queryRef: QueryReference<TData>): UseReadQueryResult<TData>;

// @public (undocumented)
export interface UseReadQueryResult<TData = unknown> {
// (undocumented)
data: TData;
networkStatus: NetworkStatus;
// (undocumented)
error: ApolloError | undefined;
};
// (undocumented)
networkStatus: NetworkStatus;
}

// @public (undocumented)
export function useSubscription<TData = any, TVariables extends OperationVariables = OperationVariables>(subscription: DocumentNode | TypedDocumentNode<TData, TVariables>, options?: SubscriptionHookOptions<NoInfer<TData>, NoInfer<TVariables>>): SubscriptionResult<TData, TVariables>;
Expand Down
12 changes: 9 additions & 3 deletions .api-reports/api-report-react_hooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1988,11 +1988,17 @@ export function useQuery<TData = any, TVariables extends OperationVariables = Op
export function useReactiveVar<T>(rv: ReactiveVar<T>): T;

// @public (undocumented)
export function useReadQuery<TData>(queryRef: QueryReference<TData>): {
export function useReadQuery<TData>(queryRef: QueryReference<TData>): UseReadQueryResult<TData>;

// @public (undocumented)
export interface UseReadQueryResult<TData = unknown> {
// (undocumented)
data: TData;
networkStatus: NetworkStatus;
// (undocumented)
error: ApolloError | undefined;
};
// (undocumented)
networkStatus: NetworkStatus;
}

// Warning: (ae-forgotten-export) The symbol "SubscriptionHookOptions" needs to be exported by the entry point index.d.ts
//
Expand Down
12 changes: 9 additions & 3 deletions .api-reports/api-report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2742,11 +2742,17 @@ export function useQuery<TData = any, TVariables extends OperationVariables = Op
export function useReactiveVar<T>(rv: ReactiveVar<T>): T;

// @public (undocumented)
export function useReadQuery<TData>(queryRef: QueryReference<TData>): {
export function useReadQuery<TData>(queryRef: QueryReference<TData>): UseReadQueryResult<TData>;

// @public (undocumented)
export interface UseReadQueryResult<TData = unknown> {
// (undocumented)
data: TData;
networkStatus: NetworkStatus;
// (undocumented)
error: ApolloError | undefined;
};
// (undocumented)
networkStatus: NetworkStatus;
}

// @public (undocumented)
export function useSubscription<TData = any, TVariables extends OperationVariables = OperationVariables>(subscription: DocumentNode | TypedDocumentNode<TData, TVariables>, options?: SubscriptionHookOptions<NoInfer<TData>, NoInfer<TVariables>>): SubscriptionResult<TData, TVariables>;
Expand Down
5 changes: 5 additions & 0 deletions .changeset/good-experts-repair.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@apollo/client": patch
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I marked this as a patch since this is a fully backwards compatible change. I'm happy to move this to a minor and merge this into release-3.9 if that makes more sense.

---

Add an explicit `UseReadQueryResult` TypeScript type for the `useReadQuery` hook.
1 change: 1 addition & 0 deletions src/react/hooks/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ export type { UseSuspenseQueryResult } from "./useSuspenseQuery.js";
export { useSuspenseQuery } from "./useSuspenseQuery.js";
export type { UseBackgroundQueryResult } from "./useBackgroundQuery.js";
export { useBackgroundQuery } from "./useBackgroundQuery.js";
export type { UseReadQueryResult } from "./useReadQuery.js";
export { useReadQuery } from "./useReadQuery.js";
export { skipToken } from "./constants.js";
export type { SkipToken } from "./constants.js";
31 changes: 30 additions & 1 deletion src/react/hooks/useReadQuery.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,37 @@ import { __use } from "./internal/index.js";
import { toApolloError } from "./useSuspenseQuery.js";
import { invariant } from "../../utilities/globals/index.js";
import { useSyncExternalStore } from "./useSyncExternalStore.js";
import type { ApolloError } from "../../errors/index.js";
import type { NetworkStatus } from "../../core/index.js";

export function useReadQuery<TData>(queryRef: QueryReference<TData>) {
export interface UseReadQueryResult<TData = unknown> {
/**
* An object containing the result of your GraphQL query after it completes.
*
* This value might be `undefined` if a query results in one or more errors
* (depending on the query's `errorPolicy`).
*/
data: TData;
/**
* If the query produces one or more errors, this object contains either an
* array of `graphQLErrors` or a single `networkError`. Otherwise, this value
* is `undefined`.
*
* This property can be ignored when using the default `errorPolicy` or an
* `errorPolicy` of `none`. The hook will throw the error instead of setting
* this property.
*/
error: ApolloError | undefined;
/**
* A number indicating the current network state of the query's associated
* request. {@link https://github.com/apollographql/apollo-client/blob/d96f4578f89b933c281bb775a39503f6cdb59ee8/src/core/networkStatus.ts#L4 | See possible values}.
*/
networkStatus: NetworkStatus;
}

export function useReadQuery<TData>(
queryRef: QueryReference<TData>
): UseReadQueryResult<TData> {
const internalQueryRef = unwrapQueryRef(queryRef);
invariant(
internalQueryRef.promiseCache,
Expand Down
Loading