@triplit/svelte 0.1.41 → 0.1.42

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/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # @triplit/svelte
2
2
 
3
+ ## 0.1.42
4
+
5
+ ### Patch Changes
6
+
7
+ - 2d2b360: add JSDoc comments
8
+ - Updated dependencies [2d2b360]
9
+ - @triplit/client@0.3.70
10
+
3
11
  ## 0.1.41
4
12
 
5
13
  ### Patch Changes
@@ -6,6 +6,8 @@ import { WorkerClient } from '@triplit/client/worker-client';
6
6
  * @param client - The client instance to query with
7
7
  * @param query - The query to subscribe to
8
8
  * @param options - Additional options for the subscription
9
+ * @param options.localOnly - If true, the subscription will only use the local cache. Defaults to false.
10
+ * @param options.onRemoteFulfilled - An optional callback that is called when the remote query has been fulfilled.
9
11
  * @returns An object containing the fetching state, the result of the query, any error that occurred, and a function to update the query
10
12
  */
11
13
  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>): {
@@ -5,6 +5,8 @@
5
5
  * @param client - The client instance to query with
6
6
  * @param query - The query to subscribe to
7
7
  * @param options - Additional options for the subscription
8
+ * @param options.localOnly - If true, the subscription will only use the local cache. Defaults to false.
9
+ * @param options.onRemoteFulfilled - An optional callback that is called when the remote query has been fulfilled.
8
10
  * @returns An object containing the fetching state, the result of the query, any error that occurred, and a function to update the query
9
11
  */
10
12
  export function useQuery(client, query, options) {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@triplit/svelte",
3
3
  "packageManager": "yarn@3.4.1",
4
- "version": "0.1.41",
4
+ "version": "0.1.42",
5
5
  "source": "./src/index.svelte.ts",
6
6
  "main": "./dist/index.svelte.js",
7
7
  "module": "./dist/index.svelte.js",
@@ -28,7 +28,7 @@
28
28
  "/dist"
29
29
  ],
30
30
  "dependencies": {
31
- "@triplit/client": "^0.3.69"
31
+ "@triplit/client": "^0.3.70"
32
32
  },
33
33
  "devDependencies": {
34
34
  "@sveltejs/package": "^2.3.0",