Skip to content

Commit 76abb16

Browse files
TkDodoTkDodo
authored
Merge branch 'main' into main
2 parents 43f0722 + d02e610 commit 76abb16

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+2000
-165
lines changed

‎docs/config.json

+17
Original file line numberDiff line numberDiff line change
@@ -737,6 +737,23 @@
737737
"to": "framework/solid/reference/createQuery"
738738
}
739739
]
740+
},
741+
{
742+
"label": "svelte",
743+
"children": [
744+
{
745+
"label": "Svelte Reference",
746+
"to": "framework/svelte/reference/index"
747+
},
748+
{
749+
"label": "Functions / createQuery",
750+
"to": "framework/svelte/reference/createquery"
751+
},
752+
{
753+
"label": "Functions / createMutation",
754+
"to": "framework/svelte/reference/createmutation"
755+
}
756+
]
740757
}
741758
]
742759
},

‎docs/framework/react/guides/filters.md

+18
Original file line numberDiff line numberDiff line change
@@ -70,3 +70,21 @@ A mutation filter object supports the following properties:
7070
- Allows for filtering mutations according to their status.
7171
- `predicate?: (mutation: Mutation) => boolean`
7272
- This predicate function will be used as a final filter on all matching mutations. If no other filters are specified, this function will be evaluated against every mutation in the cache.
73+
74+
## Utils
75+
76+
### `matchQuery`
77+
78+
```tsx
79+
const isMatching = matchQuery(filters, query)
80+
```
81+
82+
Returns a boolean that indicates whether a query matches the provided set of query filters.
83+
84+
### `matchMutation`
85+
86+
```tsx
87+
const isMatching = matchMutation(filters, mutation)
88+
```
89+
90+
Returns a boolean that indicates whether a mutation matches the provided set of mutation filters.

‎docs/framework/svelte/reference/createbasemutationresult.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
id: CreateBaseMutationResult
3+
title: CreateBaseMutationResult
4+
---
5+
6+
# Type Alias: CreateBaseMutationResult\<TData, TError, TVariables, TContext\>
7+
8+
```ts
9+
type CreateBaseMutationResult<TData, TError, TVariables, TContext>: Override<MutationObserverResult<TData, TError, TVariables, TContext>, object> & object;
10+
```
11+
12+
## Type declaration
13+
14+
### mutateAsync
15+
16+
```ts
17+
mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>
18+
```
19+
20+
## Type Parameters
21+
22+
• **TData** = `unknown`
23+
24+
• **TError** = `DefaultError`
25+
26+
• **TVariables** = `unknown`
27+
28+
• **TContext** = `unknown`
29+
30+
## Defined in
31+
32+
[packages/svelte-query/src/types.ts:113](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L113)

‎docs/framework/svelte/reference/createbasequeryoptions.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
id: CreateBaseQueryOptions
3+
title: CreateBaseQueryOptions
4+
---
5+
6+
# Type Alias: CreateBaseQueryOptions\<TQueryFnData, TError, TData, TQueryData, TQueryKey\>
7+
8+
```ts
9+
type CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>;
10+
```
11+
12+
Options for createBaseQuery
13+
14+
## Type Parameters
15+
16+
• **TQueryFnData** = `unknown`
17+
18+
• **TError** = `DefaultError`
19+
20+
• **TData** = `TQueryFnData`
21+
22+
• **TQueryData** = `TQueryFnData`
23+
24+
• **TQueryKey** _extends_ `QueryKey` = `QueryKey`
25+
26+
## Defined in
27+
28+
[packages/svelte-query/src/types.ts:23](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L23)

‎docs/framework/svelte/reference/createbasequeryresult.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
id: CreateBaseQueryResult
3+
title: CreateBaseQueryResult
4+
---
5+
6+
# Type Alias: CreateBaseQueryResult\<TData, TError\>
7+
8+
```ts
9+
type CreateBaseQueryResult<TData, TError>: Readable<QueryObserverResult<TData, TError>>;
10+
```
11+
12+
Result from createBaseQuery
13+
14+
## Type Parameters
15+
16+
• **TData** = `unknown`
17+
18+
• **TError** = `DefaultError`
19+
20+
## Defined in
21+
22+
[packages/svelte-query/src/types.ts:32](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L32)

‎docs/framework/svelte/reference/createinfinitequery.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
id: createInfiniteQuery
3+
title: createInfiniteQuery
4+
---
5+
6+
# Function: createInfiniteQuery()
7+
8+
```ts
9+
function createInfiniteQuery<
10+
TQueryFnData,
11+
TError,
12+
TData,
13+
TQueryKey,
14+
TPageParam,
15+
>(options, queryClient?): CreateInfiniteQueryResult<TData, TError>
16+
```
17+
18+
## Type Parameters
19+
20+
• **TQueryFnData**
21+
22+
• **TError** = `Error`
23+
24+
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
25+
26+
• **TQueryKey** _extends_ `QueryKey` = `QueryKey`
27+
28+
• **TPageParam** = `unknown`
29+
30+
## Parameters
31+
32+
• **options**: [`StoreOrVal`](storeorval.md)\<[`CreateInfiniteQueryOptions`](createinfinitequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `TPageParam`\>\>
33+
34+
• **queryClient?**: `QueryClient`
35+
36+
## Returns
37+
38+
[`CreateInfiniteQueryResult`](createinfinitequeryresult.md)\<`TData`, `TError`\>
39+
40+
## Defined in
41+
42+
[packages/svelte-query/src/createInfiniteQuery.ts:16](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createInfiniteQuery.ts#L16)

‎docs/framework/svelte/reference/createinfinitequeryoptions.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
id: CreateInfiniteQueryOptions
3+
title: CreateInfiniteQueryOptions
4+
---
5+
6+
# Type Alias: CreateInfiniteQueryOptions\<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam\>
7+
8+
```ts
9+
type CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>: InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>;
10+
```
11+
12+
Options for createInfiniteQuery
13+
14+
## Type Parameters
15+
16+
• **TQueryFnData** = `unknown`
17+
18+
• **TError** = `DefaultError`
19+
20+
• **TData** = `TQueryFnData`
21+
22+
• **TQueryData** = `TQueryFnData`
23+
24+
• **TQueryKey** _extends_ `QueryKey` = `QueryKey`
25+
26+
• **TPageParam** = `unknown`
27+
28+
## Defined in
29+
30+
[packages/svelte-query/src/types.ts:52](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L52)

‎docs/framework/svelte/reference/createinfinitequeryresult.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
id: CreateInfiniteQueryResult
3+
title: CreateInfiniteQueryResult
4+
---
5+
6+
# Type Alias: CreateInfiniteQueryResult\<TData, TError\>
7+
8+
```ts
9+
type CreateInfiniteQueryResult<TData, TError>: Readable<InfiniteQueryObserverResult<TData, TError>>;
10+
```
11+
12+
Result from createInfiniteQuery
13+
14+
## Type Parameters
15+
16+
• **TData** = `unknown`
17+
18+
• **TError** = `DefaultError`
19+
20+
## Defined in
21+
22+
[packages/svelte-query/src/types.ts:69](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L69)

‎docs/framework/svelte/reference/createmutateasyncfunction.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
id: CreateMutateAsyncFunction
3+
title: CreateMutateAsyncFunction
4+
---
5+
6+
# Type Alias: CreateMutateAsyncFunction\<TData, TError, TVariables, TContext\>
7+
8+
```ts
9+
type CreateMutateAsyncFunction<TData, TError, TVariables, TContext>: MutateFunction<TData, TError, TVariables, TContext>;
10+
```
11+
12+
## Type Parameters
13+
14+
• **TData** = `unknown`
15+
16+
• **TError** = `DefaultError`
17+
18+
• **TVariables** = `void`
19+
20+
• **TContext** = `unknown`
21+
22+
## Defined in
23+
24+
[packages/svelte-query/src/types.ts:106](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L106)

‎docs/framework/svelte/reference/createmutatefunction.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
id: CreateMutateFunction
3+
title: CreateMutateFunction
4+
---
5+
6+
# Type Alias: CreateMutateFunction()\<TData, TError, TVariables, TContext\>
7+
8+
```ts
9+
type CreateMutateFunction<TData, TError, TVariables, TContext>: (...args) => void;
10+
```
11+
12+
## Type Parameters
13+
14+
• **TData** = `unknown`
15+
16+
• **TError** = `DefaultError`
17+
18+
• **TVariables** = `void`
19+
20+
• **TContext** = `unknown`
21+
22+
## Parameters
23+
24+
• ...**args**: `Parameters`\<`MutateFunction`\<`TData`, `TError`, `TVariables`, `TContext`\>\>
25+
26+
## Returns
27+
28+
`void`
29+
30+
## Defined in
31+
32+
[packages/svelte-query/src/types.ts:97](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L97)

‎docs/framework/svelte/reference/createmutation.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
id: createMutation
3+
title: createMutation
4+
---
5+
6+
# Function: createMutation()
7+
8+
```ts
9+
function createMutation<TData, TError, TVariables, TContext>(
10+
options,
11+
queryClient?,
12+
): CreateMutationResult<TData, TError, TVariables, TContext>
13+
```
14+
15+
## Type Parameters
16+
17+
• **TData** = `unknown`
18+
19+
• **TError** = `Error`
20+
21+
• **TVariables** = `void`
22+
23+
• **TContext** = `unknown`
24+
25+
## Parameters
26+
27+
• **options**: [`StoreOrVal`](storeorval.md)\<[`CreateMutationOptions`](createmutationoptions.md)\<`TData`, `TError`, `TVariables`, `TContext`\>\>
28+
29+
• **queryClient?**: `QueryClient`
30+
31+
## Returns
32+
33+
[`CreateMutationResult`](createmutationresult.md)\<`TData`, `TError`, `TVariables`, `TContext`\>
34+
35+
## Defined in
36+
37+
[packages/svelte-query/src/createMutation.ts:13](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createMutation.ts#L13)

‎docs/framework/svelte/reference/createmutationoptions.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
id: CreateMutationOptions
3+
title: CreateMutationOptions
4+
---
5+
6+
# Type Alias: CreateMutationOptions\<TData, TError, TVariables, TContext\>
7+
8+
```ts
9+
type CreateMutationOptions<TData, TError, TVariables, TContext>: OmitKeyof<MutationObserverOptions<TData, TError, TVariables, TContext>, "_defaulted">;
10+
```
11+
12+
Options for createMutation
13+
14+
## Type Parameters
15+
16+
• **TData** = `unknown`
17+
18+
• **TError** = `DefaultError`
19+
20+
• **TVariables** = `void`
21+
22+
• **TContext** = `unknown`
23+
24+
## Defined in
25+
26+
[packages/svelte-query/src/types.ts:87](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L87)

‎docs/framework/svelte/reference/createmutationresult.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
id: CreateMutationResult
3+
title: CreateMutationResult
4+
---
5+
6+
# Type Alias: CreateMutationResult\<TData, TError, TVariables, TContext\>
7+
8+
```ts
9+
type CreateMutationResult<TData, TError, TVariables, TContext>: Readable<CreateBaseMutationResult<TData, TError, TVariables, TContext>>;
10+
```
11+
12+
Result from createMutation
13+
14+
## Type Parameters
15+
16+
• **TData** = `unknown`
17+
18+
• **TError** = `DefaultError`
19+
20+
• **TVariables** = `unknown`
21+
22+
• **TContext** = `unknown`
23+
24+
## Defined in
25+
26+
[packages/svelte-query/src/types.ts:126](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L126)

0 commit comments

Comments
 (0)