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.
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
Use more default type parameters for mutation-related types in react/types/types.ts
#8573
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
benjamn
added
2021-08
⏮ compatibility
backwards compatibility-related issues and PRs
⛑ TypeScript
labels
Aug 2, 2021
Here's the full diff for this file (on this PR branch) from just before #7902, demonstrating defaults are provided for all new type parameters, and existing default types are preserved: diff --git a/src/react/types/types.ts b/src/react/types/types.ts
index c91f837f3..3f957a9bd 100644
--- a/src/react/types/types.ts
+++ b/src/react/types/types.ts
@@ -6,25 +6,24 @@ import { Observable } from '../../utilities';
import { FetchResult } from '../../link/core';
import { ApolloError } from '../../errors';
import {
+ ApolloCache,
ApolloClient,
ApolloQueryResult,
- ErrorPolicy,
+ DefaultContext,
FetchMoreOptions,
FetchMoreQueryOptions,
FetchPolicy,
- MutationUpdaterFn,
+ MutationOptions,
NetworkStatus,
ObservableQuery,
OperationVariables,
- PureQueryOptions,
- ReobserveQueryCallback,
- WatchQueryFetchPolicy,
+ InternalRefetchQueriesInclude,
WatchQueryOptions,
} from '../../core';
/* Common types */
-export type Context = Record<string, any>;
+export type { DefaultContext as Context } from "../../core";
export type CommonOptions<TOptions> = TOptions & {
client?: ApolloClient<object>;
@@ -36,7 +35,7 @@ export interface BaseQueryOptions<TVariables = OperationVariables>
extends Omit<WatchQueryOptions<TVariables>, "query"> {
ssr?: boolean;
client?: ApolloClient<any>;
- context?: Context;
+ context?: DefaultContext;
}
export interface QueryFunctionOptions<
@@ -102,7 +101,7 @@ export interface LazyQueryHookOptions<
export interface QueryLazyOptions<TVariables> {
variables?: TVariables;
- context?: Context;
+ context?: DefaultContext;
}
type UnexecutedLazyFields = {
@@ -138,40 +137,31 @@ export type QueryTuple<TData, TVariables> = [
export type RefetchQueriesFunction = (
...args: any[]
-) => Array<string | PureQueryOptions>;
+) => InternalRefetchQueriesInclude;
export interface BaseMutationOptions<
TData = any,
- TVariables = OperationVariables
+ TVariables = OperationVariables,
+ TContext = DefaultContext,
+ TCache extends ApolloCache<any> = ApolloCache<any>
+> extends Omit<
+ MutationOptions<TData, TVariables, TContext, TCache>,
+ | "mutation"
> {
- variables?: TVariables;
- optimisticResponse?: TData | ((vars: TVariables) => TData);
- refetchQueries?: Array<string | PureQueryOptions> | RefetchQueriesFunction;
- awaitRefetchQueries?: boolean;
- errorPolicy?: ErrorPolicy;
- update?: MutationUpdaterFn<TData>;
- reobserveQuery?: ReobserveQueryCallback;
client?: ApolloClient<object>;
notifyOnNetworkStatusChange?: boolean;
- context?: Context;
onCompleted?: (data: TData) => void;
onError?: (error: ApolloError) => void;
- fetchPolicy?: Extract<WatchQueryFetchPolicy, 'no-cache'>;
ignoreResults?: boolean;
}
export interface MutationFunctionOptions<
TData = any,
- TVariables = OperationVariables
-> {
- variables?: TVariables;
- optimisticResponse?: TData | ((vars: TVariables) => TData);
- refetchQueries?: Array<string | PureQueryOptions> | RefetchQueriesFunction;
- awaitRefetchQueries?: boolean;
- update?: MutationUpdaterFn<TData>;
- reobserveQuery?: ReobserveQueryCallback;
- context?: Context;
- fetchPolicy?: WatchQueryFetchPolicy;
+ TVariables = OperationVariables,
+ TContext = DefaultContext,
+ TCache extends ApolloCache<any> = ApolloCache<any>,
+> extends BaseMutationOptions<TData, TVariables, TContext, TCache> {
+ mutation?: DocumentNode | TypedDocumentNode<TData, TVariables>;
}
export interface MutationResult<TData = any> {
@@ -184,28 +174,41 @@ export interface MutationResult<TData = any> {
export declare type MutationFunction<
TData = any,
- TVariables = OperationVariables
+ TVariables = OperationVariables,
+ TContext = DefaultContext,
+ TCache extends ApolloCache<any> = ApolloCache<any>,
> = (
- options?: MutationFunctionOptions<TData, TVariables>
+ options?: MutationFunctionOptions<TData, TVariables, TContext, TCache>
) => Promise<FetchResult<TData>>;
export interface MutationHookOptions<
TData = any,
- TVariables = OperationVariables
-> extends BaseMutationOptions<TData, TVariables> {
+ TVariables = OperationVariables,
+ TContext = DefaultContext,
+ TCache extends ApolloCache<any> = ApolloCache<any>,
+> extends BaseMutationOptions<TData, TVariables, TContext, TCache> {
mutation?: DocumentNode | TypedDocumentNode<TData, TVariables>;
}
-export interface MutationDataOptions<TData = any, TVariables = OperationVariables>
- extends BaseMutationOptions<TData, TVariables> {
+export interface MutationDataOptions<
+ TData = any,
+ TVariables = OperationVariables,
+ TContext = DefaultContext,
+ TCache extends ApolloCache<any> = ApolloCache<any>,
+> extends BaseMutationOptions<TData, TVariables, TContext, TCache> {
mutation: DocumentNode | TypedDocumentNode<TData, TVariables>;
}
-export type MutationTuple<TData, TVariables> = [
+export type MutationTuple<
+ TData,
+ TVariables,
+ TContext = DefaultContext,
+ TCache extends ApolloCache<any> = ApolloCache<any>,
+> = [
(
- options?: MutationFunctionOptions<TData, TVariables>
+ options?: MutationFunctionOptions<TData, TVariables, TContext, TCache>
) => Promise<FetchResult<TData>>,
- MutationResult<TData>
+ MutationResult<TData>,
];
/* Subscription types */
@@ -226,7 +229,7 @@ export interface BaseSubscriptionOptions<
| ((options: BaseSubscriptionOptions<TData, TVariables>) => boolean);
client?: ApolloClient<object>;
skip?: boolean;
- context?: Context;
+ context?: DefaultContext;
onSubscriptionData?: (options: OnSubscriptionDataOptions<TData>) => any;
onSubscriptionComplete?: () => void;
} Generated with this command: git diff 3f2eee7e8d6a4874120b6c84707b565ebcdaa349~1.. src/react/types/types.ts |
brainkim
reviewed
Aug 2, 2021
brainkim
reviewed
Aug 2, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Commit 3f2eee7 in #7902 added a number of new type parameters to existing types, without always providing a default.
Should alleviate #8572.