chore: add jsdoc

NaturalCycles · Sep 30, 2024 · b02fb61 · b02fb61
1 parent d36c67b
commit b02fb61
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/src/kv/commonKeyValueDB.ts b/src/kv/commonKeyValueDB.ts
@@ -50,5 +50,12 @@ export interface CommonKeyValueDB {
 
   count: (table: string) => Promise<number>
 
+  /**
+   *
+   * Increments the value of a key in a table by a given amount.
+   * Default increment is 1 when `by` is not provided.
+   *
+   * Returns the new value.
+   */
   increment: (table: string, id: string, by?: number) => Promise<number>
 }
diff --git a/src/kv/commonKeyValueDao.ts b/src/kv/commonKeyValueDao.ts
@@ -253,6 +253,12 @@ export class CommonKeyValueDao<T> {
     )
   }
 
+  /**
+   * Increments the `id` field by the amount specified in `by`,
+   * or by 1 if `by` is not specified.
+   *
+   * Returns the new value of the field.
+   */
   async increment(id: string, by = 1): Promise<number> {
     return await this.cfg.db.increment(this.cfg.table, id, by)
   }