Skip to content

Improve useSubscription hook types #277

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve useSubscription hook types #277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 2 additions & 4 deletions src/RelayHooksTypes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,12 +197,10 @@ export interface ReturnTypePaginationSuspense<
refetch: RefetchFnDynamic<TQuery, TKey>;
}

export type SubscriptionConfig = {
skip?: boolean;
};
export type SubscriptionConfig = Record<string, never>; // allows only empty object

export type SkipSubscriptionConfig = {
skip: true;
skip: boolean;
};

export interface SkipGraphQLSubscriptionConfig<TSubscription extends OperationType>
Expand Down
2 changes: 1 addition & 1 deletion src/useSubscription.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export function useSubscription<TSubscriptionPayload extends OperationType = Ope
): void;
export function useSubscription<TSubscriptionPayload extends OperationType = OperationType>(
config: GraphQLSubscriptionConfig<TSubscriptionPayload>,
opts?: SubscriptionConfig,
opts?: SubscriptionConfig | SkipSubscriptionConfig,
): void {
const environment = useRelayEnvironment();
const skip = opts && opts.skip;
Expand Down