Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/svelte-query-persister-options.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@tanstack/svelte-query': patch
---

Fix createQuery types to allow overriding query persisters per query.
8 changes: 7 additions & 1 deletion packages/svelte-query/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import type {
QueryKey,
QueryObserverOptions,
QueryObserverResult,
QueryPersister,
} from '@tanstack/query-core'

export type Accessor<T> = () => T
Expand All @@ -41,7 +42,12 @@ export type CreateQueryOptions<
TError = DefaultError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> = CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>
> = OmitKeyof<
CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>,
'persister'
> & {
persister?: QueryPersister<any, any>
}

/** Result from createQuery */
export type CreateQueryResult<
Expand Down
21 changes: 21 additions & 0 deletions packages/svelte-query/tests/createQuery/createQuery.test-d.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,29 @@
import { describe, expectTypeOf, it } from 'vitest'
import { queryKey } from '@tanstack/query-test-utils'
import { createQuery, queryOptions } from '../../src/index.js'
import type {
Query,
QueryFunctionContext,
QueryKey,
} from '@tanstack/query-core'

describe('createQuery', () => {
it('should allow a per-query persister', () => {
const persister = undefined as unknown as <T, TQueryKey extends QueryKey>(
queryFn: (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>,
context: QueryFunctionContext<TQueryKey>,
query: Query,
) => Promise<T>

const { data } = createQuery(() => ({
queryKey: ['todos'],
queryFn: () => Promise.resolve(['todo']),
persister,
}))

expectTypeOf(data).toEqualTypeOf<Array<string> | undefined>()
})

describe('initialData', () => {
describe('Config object overload', () => {
it('TData should always be defined when initialData is provided as an object', () => {
Expand Down