@orpc/vue-query 1.11.3 → 1.12.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/index.d.mts +6 -6
- package/dist/index.d.ts +6 -6
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<div align="center">
|
|
2
|
-
<image align="center" src="https://orpc.
|
|
2
|
+
<image align="center" src="https://orpc.dev/logo.webp" width=280 alt="oRPC logo" />
|
|
3
3
|
</div>
|
|
4
4
|
|
|
5
5
|
<h1></h1>
|
|
@@ -45,7 +45,7 @@
|
|
|
45
45
|
|
|
46
46
|
## Documentation
|
|
47
47
|
|
|
48
|
-
You can find the full documentation [here](https://orpc.
|
|
48
|
+
You can find the full documentation [here](https://orpc.dev).
|
|
49
49
|
|
|
50
50
|
## Packages
|
|
51
51
|
|
|
@@ -66,7 +66,7 @@ You can find the full documentation [here](https://orpc.unnoq.com).
|
|
|
66
66
|
|
|
67
67
|
## `@orpc/vue-query`
|
|
68
68
|
|
|
69
|
-
Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview). Read the [documentation](https://orpc.
|
|
69
|
+
Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview). Read the [documentation](https://orpc.dev/docs/integrations/tanstack-query-old/vue) for more information.
|
|
70
70
|
|
|
71
71
|
```ts
|
|
72
72
|
export function Setup() {
|
package/dist/index.d.mts
CHANGED
|
@@ -9,7 +9,7 @@ interface GeneralUtils<TInput> {
|
|
|
9
9
|
/**
|
|
10
10
|
* Generate a query/mutation key for checking status, invalidate, set, get, etc.
|
|
11
11
|
*
|
|
12
|
-
* @see {@link https://orpc.
|
|
12
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
13
13
|
*/
|
|
14
14
|
key<UType extends OperationType>(options?: OperationKeyOptions<UType, TInput>): QueryKey;
|
|
15
15
|
}
|
|
@@ -78,25 +78,25 @@ interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput,
|
|
|
78
78
|
/**
|
|
79
79
|
* Calling corresponding procedure client
|
|
80
80
|
*
|
|
81
|
-
* @see {@link https://orpc.
|
|
81
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#calling-procedure-clients Tanstack Calling Procedure Client Docs}
|
|
82
82
|
*/
|
|
83
83
|
call: Client<TClientContext, TInput, TOutput, TError>;
|
|
84
84
|
/**
|
|
85
85
|
* Generate options used for useQuery/prefetchQuery/...
|
|
86
86
|
*
|
|
87
|
-
* @see {@link https://orpc.
|
|
87
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#query-options-utility Tanstack Query Options Utility Docs}
|
|
88
88
|
*/
|
|
89
89
|
queryOptions<U, USelectData = TOutput>(...rest: MaybeOptionalOptions<U & QueryOptionsIn<TClientContext, TInput, TOutput, TError, USelectData>>): NoInfer<U & Omit<QueryOptionsBase<TOutput, TError>, keyof U>>;
|
|
90
90
|
/**
|
|
91
91
|
* Generate options used for useInfiniteQuery/prefetchInfiniteQuery/...
|
|
92
92
|
*
|
|
93
|
-
* @see {@link https://orpc.
|
|
93
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#infinite-query-options-utility Tanstack Infinite Query Options Utility Docs}
|
|
94
94
|
*/
|
|
95
95
|
infiniteOptions<U, UPageParam, USelectData = InfiniteData<TOutput, UPageParam>>(options: U & InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, USelectData, UPageParam>): NoInfer<U & Omit<InfiniteOptionsBase<TOutput, TError, UPageParam>, keyof U>>;
|
|
96
96
|
/**
|
|
97
97
|
* Generate options used for useMutation/...
|
|
98
98
|
*
|
|
99
|
-
* @see {@link https://orpc.
|
|
99
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#mutation-options Tanstack Mutation Options Docs}
|
|
100
100
|
*/
|
|
101
101
|
mutationOptions<UMutationContext>(...rest: MaybeOptionalOptions<MutationOptionsIn<TClientContext, TInput, TOutput, TError, UMutationContext>>): MutationOptions<TInput, TOutput, TError, UMutationContext>;
|
|
102
102
|
}
|
|
@@ -115,7 +115,7 @@ interface CreateRouterUtilsOptions {
|
|
|
115
115
|
* Create a router utils from a client.
|
|
116
116
|
*
|
|
117
117
|
* @info Both client-side and server-side clients are supported.
|
|
118
|
-
* @see {@link https://orpc.
|
|
118
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/vue Tanstack Query Vue Docs}
|
|
119
119
|
*/
|
|
120
120
|
declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions): RouterUtils<T>;
|
|
121
121
|
|
package/dist/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@ interface GeneralUtils<TInput> {
|
|
|
9
9
|
/**
|
|
10
10
|
* Generate a query/mutation key for checking status, invalidate, set, get, etc.
|
|
11
11
|
*
|
|
12
|
-
* @see {@link https://orpc.
|
|
12
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#query-mutation-key Tanstack Query/Mutation Key Docs}
|
|
13
13
|
*/
|
|
14
14
|
key<UType extends OperationType>(options?: OperationKeyOptions<UType, TInput>): QueryKey;
|
|
15
15
|
}
|
|
@@ -78,25 +78,25 @@ interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput,
|
|
|
78
78
|
/**
|
|
79
79
|
* Calling corresponding procedure client
|
|
80
80
|
*
|
|
81
|
-
* @see {@link https://orpc.
|
|
81
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#calling-procedure-clients Tanstack Calling Procedure Client Docs}
|
|
82
82
|
*/
|
|
83
83
|
call: Client<TClientContext, TInput, TOutput, TError>;
|
|
84
84
|
/**
|
|
85
85
|
* Generate options used for useQuery/prefetchQuery/...
|
|
86
86
|
*
|
|
87
|
-
* @see {@link https://orpc.
|
|
87
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#query-options-utility Tanstack Query Options Utility Docs}
|
|
88
88
|
*/
|
|
89
89
|
queryOptions<U, USelectData = TOutput>(...rest: MaybeOptionalOptions<U & QueryOptionsIn<TClientContext, TInput, TOutput, TError, USelectData>>): NoInfer<U & Omit<QueryOptionsBase<TOutput, TError>, keyof U>>;
|
|
90
90
|
/**
|
|
91
91
|
* Generate options used for useInfiniteQuery/prefetchInfiniteQuery/...
|
|
92
92
|
*
|
|
93
|
-
* @see {@link https://orpc.
|
|
93
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#infinite-query-options-utility Tanstack Infinite Query Options Utility Docs}
|
|
94
94
|
*/
|
|
95
95
|
infiniteOptions<U, UPageParam, USelectData = InfiniteData<TOutput, UPageParam>>(options: U & InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, USelectData, UPageParam>): NoInfer<U & Omit<InfiniteOptionsBase<TOutput, TError, UPageParam>, keyof U>>;
|
|
96
96
|
/**
|
|
97
97
|
* Generate options used for useMutation/...
|
|
98
98
|
*
|
|
99
|
-
* @see {@link https://orpc.
|
|
99
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/basic#mutation-options Tanstack Mutation Options Docs}
|
|
100
100
|
*/
|
|
101
101
|
mutationOptions<UMutationContext>(...rest: MaybeOptionalOptions<MutationOptionsIn<TClientContext, TInput, TOutput, TError, UMutationContext>>): MutationOptions<TInput, TOutput, TError, UMutationContext>;
|
|
102
102
|
}
|
|
@@ -115,7 +115,7 @@ interface CreateRouterUtilsOptions {
|
|
|
115
115
|
* Create a router utils from a client.
|
|
116
116
|
*
|
|
117
117
|
* @info Both client-side and server-side clients are supported.
|
|
118
|
-
* @see {@link https://orpc.
|
|
118
|
+
* @see {@link https://orpc.dev/docs/integrations/tanstack-query-old/vue Tanstack Query Vue Docs}
|
|
119
119
|
*/
|
|
120
120
|
declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions): RouterUtils<T>;
|
|
121
121
|
|
package/package.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orpc/vue-query",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "1.
|
|
4
|
+
"version": "1.12.1",
|
|
5
5
|
"license": "MIT",
|
|
6
|
-
"homepage": "https://orpc.
|
|
6
|
+
"homepage": "https://orpc.dev",
|
|
7
7
|
"repository": {
|
|
8
8
|
"type": "git",
|
|
9
9
|
"url": "git+https://github.com/unnoq/orpc.git",
|
|
@@ -29,14 +29,14 @@
|
|
|
29
29
|
"peerDependencies": {
|
|
30
30
|
"@tanstack/vue-query": ">=5.80.2",
|
|
31
31
|
"vue": ">=3.3.0",
|
|
32
|
-
"@orpc/client": "1.
|
|
32
|
+
"@orpc/client": "1.12.1"
|
|
33
33
|
},
|
|
34
34
|
"dependencies": {
|
|
35
|
-
"@orpc/shared": "1.
|
|
36
|
-
"@orpc/tanstack-query": "1.
|
|
35
|
+
"@orpc/shared": "1.12.1",
|
|
36
|
+
"@orpc/tanstack-query": "1.12.1"
|
|
37
37
|
},
|
|
38
38
|
"devDependencies": {
|
|
39
|
-
"@tanstack/vue-query": "^5.91.
|
|
39
|
+
"@tanstack/vue-query": "^5.91.2"
|
|
40
40
|
},
|
|
41
41
|
"scripts": {
|
|
42
42
|
"build": "unbuild",
|