@triplit/svelte 0.1.39 → 0.1.40

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @triplit/svelte
 
+## 0.1.40
+
+### Patch Changes
+
+- 7279628: add JSDoc comments
+- Updated dependencies [20b8bca]
+  - @triplit/client@0.3.68
+
 ## 0.1.39
 
 ### Patch Changes

package/dist/index.svelte.d.ts

@@ -1,5 +1,13 @@
 import type { ClientFetchResult, ClientQuery, ClientQueryBuilder, Models, SubscriptionOptions, TriplitClient, Unalias } from '@triplit/client';
 import { WorkerClient } from '@triplit/client/worker-client';
+/**
+ * A hook that subscribes to a query
+ *
+ * @param client - The client instance to query with
+ * @param query - The query to subscribe to
+ * @param options - Additional options for the subscription
+ * @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>): {
     fetching: boolean;
     fetchingLocal: boolean;
@@ -8,6 +16,12 @@ export declare function useQuery<M extends Models<any, any> | undefined, Q exten
     error: any;
     updateQuery: (query: ClientQueryBuilder<Q>) => void;
 };
+/**
+ * A hook that subscribes to the connection status of a client with the server
+ *
+ * @param client - The client instance to get the connection status of
+ * @returns An object containing `status`, the current connection status of the client with the server
+ */
 export declare function useConnectionStatus(client: TriplitClient<any> | WorkerClient<any>): {
     readonly status: string;
 };

package/dist/index.svelte.js

@@ -1,4 +1,12 @@
 /// <reference types="svelte" />
+/**
+ * A hook that subscribes to a query
+ *
+ * @param client - The client instance to query with
+ * @param query - The query to subscribe to
+ * @param options - Additional options for the subscription
+ * @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) {
     let results = $state(undefined);
     let isInitialFetch = $state(true);
@@ -72,6 +80,12 @@ export function useQuery(client, query, options) {
         updateQuery,
     };
 }
+/**
+ * A hook that subscribes to the connection status of a client with the server
+ *
+ * @param client - The client instance to get the connection status of
+ * @returns An object containing `status`, the current connection status of the client with the server
+ */
 export function useConnectionStatus(client) {
     let status = $state('CONNECTING');
     $effect(() => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@triplit/svelte",
   "packageManager": "yarn@3.4.1",
-  "version": "0.1.39",
+  "version": "0.1.40",
   "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.67"
+    "@triplit/client": "^0.3.68"
   },
   "devDependencies": {
     "@sveltejs/package": "^2.3.0",