mg

solidjs-community · Sep 24, 2024 · ea7543f · ea7543f
2 parents ecd9ffb + 5a8e476
commit ea7543f
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 9 deletions.
diff --git a/.changeset/wicked-ears-compare.md b/.changeset/wicked-ears-compare.md
diff --git a/docs/src/content/docs/prpc/mutation.mdx b/docs/src/content/docs/prpc/mutation.mdx
@@ -5,7 +5,7 @@ description: 'API for the mutation$ function'
 
 **API for the mutation$ function**
 
-`mutation$` is basically a wrapper for createMutation, it should be used whenever createMutation should be used.
+`mutation$` creates a factory for constructing createMutation functions. It should be used whenever createMutation should be used.
 
 ## Usage
 

diff --git a/docs/src/content/docs/prpc/query.mdx b/docs/src/content/docs/prpc/query.mdx
@@ -5,7 +5,7 @@ description: 'API for the query$ function'
 
 **API for the query$ function**
 
-`query$` is basically a wrapper for createQuery, it should be used whenever createQuery should be used.
+`query$` creates a factory for constructing [createQuery](https://tanstack.com/query/latest/docs/framework/solid/reference/createQuery) functions. It should be used whenever createQuery should be used.
 
 ## Usage
 
@@ -30,6 +30,8 @@ const testQuery = query$({
 // input should be an accessor
 const hello = testQuery(() => ({
   hello: 'JDev',
+}), () => ({
+  deferStream: true, // additional options go here
 }))
 ```
 

diff --git a/packages/prpc/plugin/README.md b/packages/prpc/plugin/README.md
@@ -24,4 +24,4 @@ export default defineConfig({
 })
 ```
 
-Now read the [pRPC documentation](...)
+Now read the [pRPC documentation](https://mediakit-taupe.vercel.app/prpc/install)
diff --git a/packages/prpc/solid/CHANGELOG.md b/packages/prpc/solid/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @solid-mediakit/prpc
 
+## 1.2.5
+
+### Patch Changes
+
+- [`6abbe9a`](https://github.com/solidjs-community/mediakit/commit/6abbe9a22f38275f9d64deba9dabdbdc889668a1) Thanks [@OrJDev](https://github.com/OrJDev)! - feat: useUtils function
+
 ## 1.2.4
 
 ### Patch Changes

diff --git a/packages/prpc/solid/README.md b/packages/prpc/solid/README.md
@@ -87,6 +87,8 @@ const testQuery = query$({
 // input should be an accessor
 const hello = testQuery(() => ({
   hello: 'JDev',
+}), () => ({
+  deferStream: true,
 }))
 ```
 
@@ -112,6 +114,7 @@ const __$helloQuery = cache(async ({ payload: _$$payload }) => {
 const testQuery = query$({
   queryFn: __$helloQuery,
   key: 'hello',
+  deferStream: true,
 })
 ```
 

diff --git a/packages/prpc/solid/package.json b/packages/prpc/solid/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@solid-mediakit/prpc",
   "description": "A typesafed Wrapper for Solid's RPC protocol",
-  "version": "1.2.4",
+  "version": "1.2.5",
   "scripts": {
     "build": "rimraf dist && tsup --config ./tsup.config.ts",
     "clean": "pnpm clean:dist && rimraf ./node_modules .turbo .solid",
-Original file line number
+Diff line change
@@ Expand Up / @@ -24,4 +24,4 @@ export default defineConfig({ @@
     })
     ```
-    Now read the [pRPC documentation](...)
+    Now read the [pRPC documentation](https://mediakit-taupe.vercel.app/prpc/install)