@squidcloud/client 1.0.46 → 1.0.47

package/dist/typescript-client/src/document-reference.d.ts

@@ -66,14 +66,41 @@ export declare class DocumentReference<T extends DocumentData = any> {
      * is part of a transaction.
      *
      * @param data The data to update - can be partial.
+     * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
+     *   immediately.
      */
     update(data: Partial<Record<Paths<T>, any>>, transactionId?: TransactionId): Promise<void>;
     /**
      * Similar to {@link update}, but only updates the given path.
+     * @param path The path to update.
+     * @param value The value to set at the given path.
+     * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
+     *   immediately.
      */
     setInPath(path: Paths<T>, value: any, transactionId?: TransactionId): Promise<void>;
-    /** Similar to `update`, but only deletes the given path. */
+    /**
+     * Similar to `update`, but only deletes the given path.
+     * @param path The path to delete.
+     * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
+     *   immediately.
+     */
     deleteInPath(path: Paths<T>, transactionId?: TransactionId): Promise<void>;
+    /**
+     * Increments the value at the given path by the given value. The value may be both positive and negative.
+     * @param path The path to the value to increment.
+     * @param value The value to increment by.
+     * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
+     *   immediately.
+     */
+    incrementInPath(path: Paths<T>, value: number, transactionId?: TransactionId): Promise<void>;
+    /**
+     * Decrements the value at the given path by the given value. The value may be both positive and negative.
+     * @param path The path to the value to decrement.
+     * @param value The value to decrement by.
+     * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
+     *   immediately.
+     */
+    decrementInPath(path: Paths<T>, value: number, transactionId?: TransactionId): Promise<void>;
     /**
      * Inserts the document with the given data. If the document already exists, the operation will be treated as
      * `upsert`. The `insert` will be reflected optimistically locally and will be applied to the server later. If a
@@ -84,6 +111,10 @@ export declare class DocumentReference<T extends DocumentData = any> {
      *
      * The returned promise will resolve once the `insert` has been applied to the server or immediately if the `insert`
      * is part of a transaction.
+     *
+     * @param data The data to insert.
+     * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
+     *   immediately.
      */
     insert(data: T, transactionId?: TransactionId): Promise<void>;
     /**
@@ -95,6 +126,9 @@ export declare class DocumentReference<T extends DocumentData = any> {
      *
      * The returned promise will resolve once the `delete` has been applied to the server or immediately if the `delete`
      * is part of a transaction.
+     *
+     * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
+     *   immediately.
      */
     delete(transactionId?: TransactionId): Promise<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.46",
+  "version": "1.0.47",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/index.js",
   "types": "dist/typescript-client/src/index.d.ts",