@falcondev-oss/trpc-vue-query 0.4.0 → 0.4.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 +5 -1
- package/dist/index.d.cts +5 -5
- package/dist/index.d.ts +5 -5
- package/package.json +15 -15
package/README.md
CHANGED
|
@@ -10,6 +10,10 @@ A tRPC wrapper around @tanstack/vue-query. This package provides a set of hooks
|
|
|
10
10
|
pnpm add @falcondev-oss/trpc-vue-query
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
+
## Documentation
|
|
14
|
+
|
|
15
|
+
👉 <https://trpc-vue-query.falcondev.io/getting-started> 👈
|
|
16
|
+
|
|
13
17
|
## Usage with Vue
|
|
14
18
|
|
|
15
19
|
### 1. Create client & composable
|
|
@@ -22,7 +26,7 @@ import { VueQueryPlugin, useQueryClient } from '@tanstack/vue-query'
|
|
|
22
26
|
app.use(VueQueryPlugin)
|
|
23
27
|
app.use({
|
|
24
28
|
install(app) {
|
|
25
|
-
const queryClient = useQueryClient
|
|
29
|
+
const queryClient = app.runWithContext(useQueryClient)
|
|
26
30
|
const trpc = createTRPCVueQueryClient<AppRouter>({
|
|
27
31
|
queryClient,
|
|
28
32
|
trpc: {
|
package/dist/index.d.cts
CHANGED
|
@@ -18,19 +18,19 @@ type SubscriptionResolver<TProcedure extends AnyProcedure, TRouter extends AnyRo
|
|
|
18
18
|
opts: ProcedureArgs<TProcedure['_def']>[1] & Partial<TRPCSubscriptionObserver<inferObservableValue<inferProcedureOutput<TProcedure>>, TRPCClientErrorLike<TRouter>>>
|
|
19
19
|
]) => Unsubscribable;
|
|
20
20
|
type DecorateProcedure<TProcedure extends AnyProcedure, TRouter extends AnyRouter> = TProcedure extends AnyQueryProcedure ? {
|
|
21
|
-
useQuery: <
|
|
21
|
+
useQuery: <TQueryFnData, TError = TRPCClientErrorLike<TProcedure>, TData = inferTransformedProcedureOutput<TProcedure>, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(input: MaybeRefOrGetter<inferProcedureInput<TProcedure>>, opts?: MaybeRefOrGetter<Omit<UnwrapRef<UseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>>, 'queryKey'> & {
|
|
22
22
|
trpc?: TRPCRequestOptions;
|
|
23
|
-
queryKey?:
|
|
24
|
-
}>) => UseQueryReturnType<
|
|
23
|
+
queryKey?: TQueryKey;
|
|
24
|
+
}>) => UseQueryReturnType<TData, TError>;
|
|
25
25
|
query: Resolver<TProcedure>;
|
|
26
26
|
invalidate: (input?: MaybeRefOrGetter<inferProcedureInput<TProcedure>>) => Promise<void>;
|
|
27
27
|
setQueryData: (updater: inferTransformedProcedureOutput<TProcedure>, input?: MaybeRefOrGetter<inferProcedureInput<TProcedure>>) => ReturnType<QueryClient['setQueryData']>;
|
|
28
28
|
key: (input?: MaybeRefOrGetter<inferProcedureInput<TProcedure>>) => QueryKey;
|
|
29
29
|
} : TProcedure extends AnyMutationProcedure ? {
|
|
30
30
|
mutate: Resolver<TProcedure>;
|
|
31
|
-
useMutation: <
|
|
31
|
+
useMutation: <TData = inferTransformedProcedureOutput<TProcedure>, TError = TRPCClientErrorLike<TProcedure>, TVariables = inferProcedureInput<TProcedure>, TContext = unknown>(opts?: MaybeRefOrGetter<UseMutationOptions<TData, TError, TVariables, TContext> & {
|
|
32
32
|
trpc?: TRPCRequestOptions;
|
|
33
|
-
}>) => UseMutationReturnType<
|
|
33
|
+
}>) => UseMutationReturnType<TData, TError, TVariables, TContext>;
|
|
34
34
|
} : TProcedure extends AnySubscriptionProcedure ? {
|
|
35
35
|
subscribe: SubscriptionResolver<TProcedure, TRouter>;
|
|
36
36
|
} : never;
|
package/dist/index.d.ts
CHANGED
|
@@ -18,19 +18,19 @@ type SubscriptionResolver<TProcedure extends AnyProcedure, TRouter extends AnyRo
|
|
|
18
18
|
opts: ProcedureArgs<TProcedure['_def']>[1] & Partial<TRPCSubscriptionObserver<inferObservableValue<inferProcedureOutput<TProcedure>>, TRPCClientErrorLike<TRouter>>>
|
|
19
19
|
]) => Unsubscribable;
|
|
20
20
|
type DecorateProcedure<TProcedure extends AnyProcedure, TRouter extends AnyRouter> = TProcedure extends AnyQueryProcedure ? {
|
|
21
|
-
useQuery: <
|
|
21
|
+
useQuery: <TQueryFnData, TError = TRPCClientErrorLike<TProcedure>, TData = inferTransformedProcedureOutput<TProcedure>, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(input: MaybeRefOrGetter<inferProcedureInput<TProcedure>>, opts?: MaybeRefOrGetter<Omit<UnwrapRef<UseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>>, 'queryKey'> & {
|
|
22
22
|
trpc?: TRPCRequestOptions;
|
|
23
|
-
queryKey?:
|
|
24
|
-
}>) => UseQueryReturnType<
|
|
23
|
+
queryKey?: TQueryKey;
|
|
24
|
+
}>) => UseQueryReturnType<TData, TError>;
|
|
25
25
|
query: Resolver<TProcedure>;
|
|
26
26
|
invalidate: (input?: MaybeRefOrGetter<inferProcedureInput<TProcedure>>) => Promise<void>;
|
|
27
27
|
setQueryData: (updater: inferTransformedProcedureOutput<TProcedure>, input?: MaybeRefOrGetter<inferProcedureInput<TProcedure>>) => ReturnType<QueryClient['setQueryData']>;
|
|
28
28
|
key: (input?: MaybeRefOrGetter<inferProcedureInput<TProcedure>>) => QueryKey;
|
|
29
29
|
} : TProcedure extends AnyMutationProcedure ? {
|
|
30
30
|
mutate: Resolver<TProcedure>;
|
|
31
|
-
useMutation: <
|
|
31
|
+
useMutation: <TData = inferTransformedProcedureOutput<TProcedure>, TError = TRPCClientErrorLike<TProcedure>, TVariables = inferProcedureInput<TProcedure>, TContext = unknown>(opts?: MaybeRefOrGetter<UseMutationOptions<TData, TError, TVariables, TContext> & {
|
|
32
32
|
trpc?: TRPCRequestOptions;
|
|
33
|
-
}>) => UseMutationReturnType<
|
|
33
|
+
}>) => UseMutationReturnType<TData, TError, TVariables, TContext>;
|
|
34
34
|
} : TProcedure extends AnySubscriptionProcedure ? {
|
|
35
35
|
subscribe: SubscriptionResolver<TProcedure, TRouter>;
|
|
36
36
|
} : never;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@falcondev-oss/trpc-vue-query",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.4.
|
|
4
|
+
"version": "0.4.1",
|
|
5
5
|
"packageManager": "pnpm@8.15.3",
|
|
6
6
|
"description": "A tRPC wrapper around '@tanstack/vue-query'",
|
|
7
7
|
"license": "MIT",
|
|
@@ -32,28 +32,28 @@
|
|
|
32
32
|
"@vueuse/core": "^10.9.0"
|
|
33
33
|
},
|
|
34
34
|
"devDependencies": {
|
|
35
|
-
"@commitlint/cli": "^19.
|
|
35
|
+
"@commitlint/cli": "^19.2.1",
|
|
36
36
|
"@eslint/eslintrc": "^3.0.2",
|
|
37
|
-
"@louishaftmann/commitlint-config": "^3.
|
|
38
|
-
"@louishaftmann/eslint-config": "^3.
|
|
39
|
-
"@louishaftmann/lintstaged-config": "^3.
|
|
40
|
-
"@louishaftmann/prettier-config": "^3.
|
|
41
|
-
"@tanstack/vue-query": "^5.
|
|
42
|
-
"@trpc/client": "^10.45.
|
|
43
|
-
"@trpc/server": "^10.45.
|
|
44
|
-
"@types/eslint": "^8.56.
|
|
37
|
+
"@louishaftmann/commitlint-config": "^3.1.1",
|
|
38
|
+
"@louishaftmann/eslint-config": "^3.1.1",
|
|
39
|
+
"@louishaftmann/lintstaged-config": "^3.1.1",
|
|
40
|
+
"@louishaftmann/prettier-config": "^3.1.1",
|
|
41
|
+
"@tanstack/vue-query": "^5.29.0",
|
|
42
|
+
"@trpc/client": "^10.45.2",
|
|
43
|
+
"@trpc/server": "^10.45.2",
|
|
44
|
+
"@types/eslint": "^8.56.7",
|
|
45
45
|
"@types/eslint__eslintrc": "^2.1.1",
|
|
46
|
-
"@vitest/ui": "^1.
|
|
46
|
+
"@vitest/ui": "^1.4.0",
|
|
47
47
|
"eslint": "^8.57.0",
|
|
48
|
-
"happy-dom": "^13.
|
|
48
|
+
"happy-dom": "^13.10.1",
|
|
49
49
|
"husky": "^9.0.11",
|
|
50
50
|
"lint-staged": "^15.2.2",
|
|
51
51
|
"prettier": "^3.2.5",
|
|
52
52
|
"start-server-and-test": "^2.0.3",
|
|
53
53
|
"tsup": "^8.0.2",
|
|
54
|
-
"tsx": "^4.7.
|
|
55
|
-
"typescript": "^5.4.
|
|
56
|
-
"vitest": "^1.
|
|
54
|
+
"tsx": "^4.7.2",
|
|
55
|
+
"typescript": "^5.4.4",
|
|
56
|
+
"vitest": "^1.4.0",
|
|
57
57
|
"vue": "^3.4.21",
|
|
58
58
|
"vue-demi": "^0.14.7"
|
|
59
59
|
},
|