use skipToken with subscriptions

specta-rs · Jul 16, 2024 · 1166c2f · 1166c2f
1 parent be2f663
commit 1166c2f
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 8 deletions.
diff --git a/packages/query-core/src/index.ts b/packages/query-core/src/index.ts
@@ -60,10 +60,10 @@ export function createQueryHooksHelpers<P extends rspc.Procedures>() {
 	function handleSubscription(
 		client: rspc.Client<P>,
 		path: string[],
-		input: unknown,
+		input: unknown | tanstack.SkipToken,
 		opts?: () => SubscriptionOptions<unknown, unknown> | undefined,
 	): undefined | (() => void) {
-		if (!(opts?.()?.enabled ?? true)) return;
+		if (!(opts?.()?.enabled ?? true) || input === tanstack.skipToken) return;
 
 		let isStopped = false;
 

diff --git a/packages/react-query/src/hooks.tsx b/packages/react-query/src/hooks.tsx
@@ -47,7 +47,7 @@ export function createHooks<P extends rspc.Procedures>() {
 	function useSubscription(
 		path: string[],
 		...[input, opts]: [
-			unknown,
+			unknown | tanstack.SkipToken,
 			queryCore.SubscriptionOptions<unknown, unknown> | undefined,
 		]
 	) {

diff --git a/packages/react-query/src/types.ts b/packages/react-query/src/types.ts
@@ -80,7 +80,7 @@ export type ProcedureProxyMethods<
 		: P["variant"] extends "subscription"
 			? {
 					useSubscription(
-						input: P["input"],
+						input: P["input"] | tanstack.SkipToken,
 						opts?: Partial<
 							rspc.SubscriptionObserver<rspc.ProcedureResult<P>, unknown>
 						>,

diff --git a/packages/solid-query/src/hooks.tsx b/packages/solid-query/src/hooks.tsx
@@ -57,7 +57,7 @@ export function createHooks<P extends rspc.Procedures>() {
 	function createSubscription(
 		path: string[],
 		...[input, opts]: [
-			solid.Accessor<unknown>,
+			solid.Accessor<unknown | tanstack.SkipToken>,
 			opts:
 				| solid.Accessor<queryCore.SubscriptionOptions<unknown, unknown>>
 				| undefined,

diff --git a/packages/solid-query/src/types.ts b/packages/solid-query/src/types.ts
@@ -92,7 +92,7 @@ export type ProcedureProxyMethods<
 		: P["variant"] extends "subscription"
 			? {
 					createSubscription(
-						input: solid.Accessor<P["input"]>,
+						input: solid.Accessor<P["input"] | tanstack.SkipToken>,
 						opts?: solid.Accessor<
 							Partial<
 								rspc.SubscriptionObserver<rspc.ProcedureResult<P>, unknown>

diff --git a/packages/svelte-query/src/hooks.ts b/packages/svelte-query/src/hooks.ts
@@ -83,7 +83,7 @@ export function createHooks<P extends rspc.Procedures>() {
 	function createSubscription(
 		path: string[],
 		...[input, opts]: [
-			tanstack.StoreOrVal<unknown>,
+			tanstack.StoreOrVal<unknown | tanstack.SkipToken>,
 			opts:
 				| tanstack.StoreOrVal<queryCore.SubscriptionOptions<unknown, unknown>>
 				| undefined,

diff --git a/packages/svelte-query/src/types.ts b/packages/svelte-query/src/types.ts
@@ -84,7 +84,7 @@ export type ProcedureProxyMethods<
 		: P["variant"] extends "subscription"
 			? {
 					createSubscription(
-						input: tanstack.StoreOrVal<P["input"]>,
+						input: tanstack.StoreOrVal<P["input"] | tanstack.SkipToken>,
 						opts?: tanstack.StoreOrVal<
 							Partial<
 								rspc.SubscriptionObserver<rspc.ProcedureResult<P>, unknown>