diff --git a/packages/react-query/src/procedure-utils.test.ts b/packages/react-query/src/procedure-utils.test.ts index c8402465b..1d509ce17 100644 --- a/packages/react-query/src/procedure-utils.test.ts +++ b/packages/react-query/src/procedure-utils.test.ts @@ -33,7 +33,7 @@ describe('createProcedureUtils', () => { it('without skipToken', async () => { const options = utils.queryOptions({ input: { search: '__search__' }, context: { batch: '__batch__' } }) - expect(options.enabled).toBe(true) + expect(options.enabled).toBe(undefined) expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value) expect(generateOperationKeySpy).toHaveBeenCalledTimes(1) @@ -72,7 +72,7 @@ describe('createProcedureUtils', () => { queryFnOptions: { refetchMode: 'replace' }, }) - expect(options.enabled).toBe(true) + expect(options.enabled).toBe(undefined) expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value) expect(generateOperationKeySpy).toHaveBeenCalledTimes(1) @@ -130,7 +130,7 @@ describe('createProcedureUtils', () => { initialPageParam: '__initialPageParam__', }) - expect(options.enabled).toBe(true) + expect(options.enabled).toBe(undefined) expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value) expect(generateOperationKeySpy).toHaveBeenCalledTimes(1) diff --git a/packages/react-query/src/procedure-utils.ts b/packages/react-query/src/procedure-utils.ts index 474e9645a..683af02f7 100644 --- a/packages/react-query/src/procedure-utils.ts +++ b/packages/react-query/src/procedure-utils.ts @@ -87,14 +87,14 @@ export function createProcedureUtils { @@ -129,7 +129,7 @@ export function createProcedureUtils { queryFn(ctx: QueryFunctionContext): Promise throwOnError?(error: TError): boolean // Help TQ infer TError retryDelay?: (count: number, error: TError) => number // Help TQ infer TError (suspense hooks) - enabled: boolean + enabled: boolean | undefined } type experimental_StreamedQueryOptions = Omit[0], 'queryFn'> @@ -36,7 +36,7 @@ export interface InfiniteOptionsBase { queryFn(ctx: QueryFunctionContext): Promise throwOnError?(error: TError): boolean // Help TQ infer TError retryDelay?: (count: number, error: TError) => number // Help TQ infer TError (suspense hooks) - enabled: boolean + enabled: boolean | undefined } export type MutationOptionsIn diff --git a/packages/solid-query/src/procedure-utils.test.ts b/packages/solid-query/src/procedure-utils.test.ts index de18644a0..783968beb 100644 --- a/packages/solid-query/src/procedure-utils.test.ts +++ b/packages/solid-query/src/procedure-utils.test.ts @@ -33,7 +33,7 @@ describe('createProcedureUtils', () => { it('without skipToken', async () => { const options = utils.queryOptions({ input: { search: '__search__' }, context: { batch: '__batch__' } }) - expect(options.enabled).toBe(true) + expect(options.enabled).toBe(undefined) expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value) expect(generateOperationKeySpy).toHaveBeenCalledTimes(1) @@ -72,7 +72,7 @@ describe('createProcedureUtils', () => { queryFnOptions: { refetchMode: 'replace' }, }) - expect(options.enabled).toBe(true) + expect(options.enabled).toBe(undefined) expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value) expect(generateOperationKeySpy).toHaveBeenCalledTimes(1) @@ -130,7 +130,7 @@ describe('createProcedureUtils', () => { initialPageParam: '__initialPageParam__', }) - expect(options.enabled).toBe(true) + expect(options.enabled).toBe(undefined) expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value) expect(generateOperationKeySpy).toHaveBeenCalledTimes(1) diff --git a/packages/solid-query/src/procedure-utils.ts b/packages/solid-query/src/procedure-utils.ts index 964f9366d..0cb816dcb 100644 --- a/packages/solid-query/src/procedure-utils.ts +++ b/packages/solid-query/src/procedure-utils.ts @@ -77,14 +77,14 @@ export function createProcedureUtils { @@ -119,7 +119,7 @@ export function createProcedureUtils { queryFn(ctx: QueryFunctionContext): Promise throwOnError?(error: TError): boolean // Help TQ infer TError retryDelay?: (count: number, error: TError) => number // Help TQ infer TError (suspense hooks) - enabled: boolean + enabled: boolean | undefined } type experimental_StreamedQueryOptions = Omit[0]['refetchMode'], 'queryFn'> @@ -44,7 +44,7 @@ export interface InfiniteOptionsBase { queryFn(ctx: QueryFunctionContext): Promise throwOnError?(error: TError): boolean // Help TQ infer TError retryDelay?: (count: number, error: TError) => number // Help TQ infer TError (suspense hooks) - enabled: boolean + enabled: boolean | undefined } export type MutationOptionsIn diff --git a/packages/svelte-query/src/procedure-utils.test.tsx b/packages/svelte-query/src/procedure-utils.test.tsx index 4719640de..c7ab34db3 100644 --- a/packages/svelte-query/src/procedure-utils.test.tsx +++ b/packages/svelte-query/src/procedure-utils.test.tsx @@ -33,7 +33,7 @@ describe('createProcedureUtils', () => { it('without skipToken', async () => { const options = utils.queryOptions({ input: { search: '__search__' }, context: { batch: '__batch__' } }) - expect(options.enabled).toBe(true) + expect(options.enabled).toBe(undefined) expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value) expect(generateOperationKeySpy).toHaveBeenCalledTimes(1) @@ -72,7 +72,7 @@ describe('createProcedureUtils', () => { queryFnOptions: { refetchMode: 'replace' }, }) - expect(options.enabled).toBe(true) + expect(options.enabled).toBe(undefined) expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value) expect(generateOperationKeySpy).toHaveBeenCalledTimes(1) @@ -130,7 +130,7 @@ describe('createProcedureUtils', () => { initialPageParam: '__initialPageParam__', }) - expect(options.enabled).toBe(true) + expect(options.enabled).toBe(undefined) expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value) expect(generateOperationKeySpy).toHaveBeenCalledTimes(1) diff --git a/packages/svelte-query/src/procedure-utils.ts b/packages/svelte-query/src/procedure-utils.ts index dc0b093c1..260d9b70c 100644 --- a/packages/svelte-query/src/procedure-utils.ts +++ b/packages/svelte-query/src/procedure-utils.ts @@ -77,14 +77,14 @@ export function createProcedureUtils { @@ -119,7 +119,7 @@ export function createProcedureUtils { queryFn(ctx: QueryFunctionContext): Promise throwOnError?(error: TError): boolean // Help TQ infer TError retryDelay?: (count: number, error: TError) => number // Help TQ infer TError (suspense hooks) - enabled: boolean + enabled: boolean | undefined } type experimental_StreamedQueryOptions = Omit[0], 'queryFn'> @@ -44,7 +44,7 @@ export interface InfiniteOptionsBase { queryFn(ctx: QueryFunctionContext): Promise throwOnError?(error: TError): boolean // Help TQ infer TError retryDelay?: (count: number, error: TError) => number // Help TQ infer TError (suspense hooks) - enabled: boolean + enabled: boolean | undefined } export type MutationOptionsIn diff --git a/packages/tanstack-query/src/procedure-utils.test-d.ts b/packages/tanstack-query/src/procedure-utils.test-d.ts index 2c010344d..305e3571c 100644 --- a/packages/tanstack-query/src/procedure-utils.test-d.ts +++ b/packages/tanstack-query/src/procedure-utils.test-d.ts @@ -148,7 +148,7 @@ describe('ProcedureUtils', () => { maxPages: number queryFn: QueryFunction throwOnError?(error: UtilsError): boolean - enabled: boolean + enabled: boolean | undefined }>() }) @@ -281,7 +281,7 @@ describe('ProcedureUtils', () => { maxPages: number queryFn: QueryFunction throwOnError?(error: UtilsError): boolean - enabled: boolean + enabled: boolean | undefined }>() }) @@ -410,7 +410,7 @@ describe('ProcedureUtils', () => { maxPages: number queryFn: QueryFunction throwOnError?(error: UtilsError): boolean - enabled: boolean + enabled: boolean | undefined }>() }) @@ -661,7 +661,7 @@ describe('ProcedureUtils', () => { maxPages: number queryFn: QueryFunction throwOnError?(error: UtilsError): boolean - enabled: boolean + enabled: boolean | undefined }>() }) diff --git a/packages/tanstack-query/src/procedure-utils.test.ts b/packages/tanstack-query/src/procedure-utils.test.ts index 60ecf7f4f..7c9f80688 100644 --- a/packages/tanstack-query/src/procedure-utils.test.ts +++ b/packages/tanstack-query/src/procedure-utils.test.ts @@ -46,7 +46,7 @@ describe('createProcedureUtils', () => { it('without skipToken', async () => { const options = utils.queryOptions({ input: { search: '__search__' }, context: { batch: '__batch__' } }) - expect(options.enabled).toBe(true) + expect(options.enabled).toBe(undefined) expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value) expect(generateOperationKeySpy).toHaveBeenCalledTimes(1) @@ -97,7 +97,7 @@ describe('createProcedureUtils', () => { }, }) - expect(options.enabled).toBe(true) + expect(options.enabled).toBe(undefined) expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value) expect(generateOperationKeySpy).toHaveBeenCalledTimes(1) @@ -182,7 +182,7 @@ describe('createProcedureUtils', () => { context: { batch: '__batch__' }, }) - expect(options.enabled).toBe(true) + expect(options.enabled).toBe(undefined) expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value) expect(generateOperationKeySpy).toHaveBeenCalledTimes(1) @@ -268,7 +268,7 @@ describe('createProcedureUtils', () => { initialPageParam: '__initialPageParam__', }) - expect(options.enabled).toBe(true) + expect(options.enabled).toBe(undefined) expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value) expect(generateOperationKeySpy).toHaveBeenCalledTimes(1) diff --git a/packages/tanstack-query/src/procedure-utils.ts b/packages/tanstack-query/src/procedure-utils.ts index be8bae01e..98374b93e 100644 --- a/packages/tanstack-query/src/procedure-utils.ts +++ b/packages/tanstack-query/src/procedure-utils.ts @@ -184,7 +184,7 @@ export function createProcedureUtils { if (optionsIn.input === skipToken) { @@ -241,7 +241,7 @@ export function createProcedureUtils { if (optionsIn.input === skipToken) { throw new Error('queryFn should not be called with skipToken used as input') @@ -298,7 +298,7 @@ export function createProcedureUtils { queryFn: QueryFunction throwOnError?: (error: TError) => boolean // Help TQ infer TError retryDelay?: (count: number, error: TError) => number // Help TQ infer TError (suspense hooks) - enabled: boolean + enabled: boolean | undefined } export type experimental_StreamedKeyOptions @@ -75,7 +75,7 @@ export interface InfiniteOptionsBase { select?(): InfiniteData // Help TQ infer TPageParam throwOnError?: (error: TError) => boolean // Help TQ infer TError retryDelay?: (count: number, error: TError) => number // Help TQ infer TError (suspense hooks) - enabled: boolean + enabled: boolean | undefined } export type MutationOptionsIn diff --git a/packages/vue-query/src/procedure-utils.test.ts b/packages/vue-query/src/procedure-utils.test.ts index 2c9fa49f7..2d64bce31 100644 --- a/packages/vue-query/src/procedure-utils.test.ts +++ b/packages/vue-query/src/procedure-utils.test.ts @@ -34,7 +34,7 @@ describe('createProcedureUtils', () => { it('without skipToken', async () => { const options = utils.queryOptions({ input: computed(() => ({ search: ref('__search__') })), context: { batch: '__batch__' } }) - expect(options.enabled.value).toBe(true) + expect(options.enabled.value).toBe(undefined) expect(options.queryKey.value).toBe(generateOperationKeySpy.mock.results[0]!.value) expect(generateOperationKeySpy).toHaveBeenCalledTimes(1) @@ -74,7 +74,7 @@ describe('createProcedureUtils', () => { input.value = computed(() => ({ search: ref('__search__') })) - expect(options.enabled.value).toBe(true) + expect(options.enabled.value).toBe(undefined) expect(options.queryKey.value).toBe(generateOperationKeySpy.mock.results[1]!.value) expect(generateOperationKeySpy).toHaveBeenCalledTimes(2) @@ -102,7 +102,7 @@ describe('createProcedureUtils', () => { }, }) - expect(options.enabled.value).toBe(true) + expect(options.enabled.value).toBe(undefined) expect(options.queryKey.value).toBe(generateOperationKeySpy.mock.results[0]!.value) expect(generateOperationKeySpy).toHaveBeenCalledTimes(1) @@ -166,7 +166,7 @@ describe('createProcedureUtils', () => { input.value = computed(() => ({ search: ref('__search__') })) - expect(options.enabled.value).toBe(true) + expect(options.enabled.value).toBe(undefined) expect(options.queryKey.value).toBe(generateOperationKeySpy.mock.results[1]!.value) expect(generateOperationKeySpy).toHaveBeenCalledTimes(2) @@ -206,7 +206,7 @@ describe('createProcedureUtils', () => { initialPageParam: '__initialPageParam__', }) - expect(options.enabled.value).toBe(true) + expect(options.enabled.value).toBe(undefined) expect(options.queryKey.value).toBe(generateOperationKeySpy.mock.results[0]!.value) expect(generateOperationKeySpy).toHaveBeenCalledTimes(1) @@ -268,7 +268,7 @@ describe('createProcedureUtils', () => { input.value = (pageParam: any) => (computed(() => ({ search: '__search__', pageParam }))) - expect(options.enabled.value).toBe(true) + expect(options.enabled.value).toBe(undefined) expect(options.queryKey.value).toBe(generateOperationKeySpy.mock.results[1]!.value) expect(generateOperationKeySpy).toHaveBeenCalledTimes(2) diff --git a/packages/vue-query/src/procedure-utils.ts b/packages/vue-query/src/procedure-utils.ts index f44639af7..dcc8555f3 100644 --- a/packages/vue-query/src/procedure-utils.ts +++ b/packages/vue-query/src/procedure-utils.ts @@ -81,14 +81,14 @@ export function createProcedureUtils unrefDeep(optionsIn.input) !== skipToken), + enabled: computed(() => unrefDeep(optionsIn.input) === skipToken ? false : undefined), ...optionsIn, } }, experimental_streamedOptions(...[optionsIn = {} as any]) { return { - enabled: computed(() => unrefDeep(optionsIn.input) !== skipToken), + enabled: computed(() => unrefDeep(optionsIn.input) === skipToken ? false : undefined), queryKey: computed(() => generateOperationKey(options.path, { type: 'streamed', input: unrefDeep(optionsIn.input), fnOptions: optionsIn.queryFnOptions })), queryFn: experimental_streamedQuery({ queryFn: async ({ signal }) => { @@ -131,7 +131,7 @@ export function createProcedureUtils unrefDeep(optionsIn.input) !== skipToken), + enabled: computed(() => unrefDeep(optionsIn.input) === skipToken ? false : undefined), ...(optionsIn as any), } }, diff --git a/packages/vue-query/src/types.ts b/packages/vue-query/src/types.ts index 16c01bcfa..6306d5bee 100644 --- a/packages/vue-query/src/types.ts +++ b/packages/vue-query/src/types.ts @@ -33,7 +33,7 @@ export interface QueryOptionsBase { queryFn(ctx: QueryFunctionContext): Promise throwOnError?(error: TError): boolean // Help TQ infer TError retryDelay?: (count: number, error: TError) => number // Help TQ infer TError (suspense hooks) - enabled: ComputedRef + enabled: ComputedRef } type experimental_StreamedQueryOptions = Omit[0], 'queryFn'> @@ -65,7 +65,7 @@ export interface InfiniteOptionsBase { queryFn(ctx: QueryFunctionContext): Promise throwOnError?(error: TError): boolean // Help TQ infer TError retryDelay?: (count: number, error: TError) => number // Help TQ infer TError (suspense hooks) - enabled: ComputedRef + enabled: ComputedRef } export type MutationOptionsIn