@triplit/svelte 0.1.41 → 0.1.42

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @triplit/svelte
 
+## 0.1.42
+
+### Patch Changes
+
+- 2d2b360: add JSDoc comments
+- Updated dependencies [2d2b360]
+  - @triplit/client@0.3.70
+
 ## 0.1.41
 
 ### Patch Changes

package/dist/index.svelte.d.ts

@@ -6,6 +6,8 @@ import { WorkerClient } from '@triplit/client/worker-client';
  * @param client - The client instance to query with
  * @param query - The query to subscribe to
  * @param options - Additional options for the subscription
+ * @param options.localOnly - If true, the subscription will only use the local cache. Defaults to false.
+ * @param options.onRemoteFulfilled - An optional callback that is called when the remote query has been fulfilled.
  * @returns An object containing the fetching state, the result of the query, any error that occurred, and a function to update the query
  */
 export declare function useQuery<M extends Models<any, any> | undefined, Q extends ClientQuery<M, any, any, any>>(client: TriplitClient<any> | WorkerClient<any>, query: ClientQueryBuilder<Q>, options?: Partial<SubscriptionOptions>): {

package/dist/index.svelte.js

@@ -5,6 +5,8 @@
  * @param client - The client instance to query with
  * @param query - The query to subscribe to
  * @param options - Additional options for the subscription
+ * @param options.localOnly - If true, the subscription will only use the local cache. Defaults to false.
+ * @param options.onRemoteFulfilled - An optional callback that is called when the remote query has been fulfilled.
  * @returns An object containing the fetching state, the result of the query, any error that occurred, and a function to update the query
  */
 export function useQuery(client, query, options) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@triplit/svelte",
   "packageManager": "yarn@3.4.1",
-  "version": "0.1.41",
+  "version": "0.1.42",
   "source": "./src/index.svelte.ts",
   "main": "./dist/index.svelte.js",
   "module": "./dist/index.svelte.js",
@@ -28,7 +28,7 @@
     "/dist"
   ],
   "dependencies": {
-    "@triplit/client": "^0.3.69"
+    "@triplit/client": "^0.3.70"
   },
   "devDependencies": {
     "@sveltejs/package": "^2.3.0",