refactor: Rename remove method to removeItem in CollectionReference

BREAKING CHANGE: `remove` renamed to `removeItem` in CollectionReference
Alwatr · Sep 1, 2024 · 6238cae · 6238cae
1 parent 949f261
commit 6238cae
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/packages/reference/src/collection-reference.ts b/packages/reference/src/collection-reference.ts
@@ -409,11 +409,12 @@ export class CollectionReference<TItem extends JsonifiableObject = JsonifiableOb
    *
    * @example
    * ```typescript
-   * collectionRef.remove('item1');
+   * collectionRef.removeItem('item1');
+   * collectionRef.itemExists('item1'); // Output: false
    * ```
    */
-  remove(itemId: string | number): void {
-    this.logger__.logMethodArgs?.('remove', itemId);
+  removeItem(itemId: string | number): void {
+    this.logger__.logMethodArgs?.('removeItem', itemId);
     delete this.context__.data[itemId];
     this.updated__(null);
   }