added collections.truncate method

Author: ganigeorgiev

CHANGELOG.md

@@ -61,6 +61,8 @@
 
 - Added new `pb.collections.getScaffolds()` method to retrieve a type indexed map with the collection models (base, auth, view) loaded with their defaults.
 
+- Added new `pb.collections.truncate(idOrName)` to delete all records associated with the specified collection.
+
 - Added the submitted fetch options as 3rd last argument in the `pb.afterSend` hook.
 
 - ⚠️ Admins are converted to `_superusers` auth collection and there is no longer `AdminService` and `AdminModel` types.

README.md

@@ -936,17 +936,20 @@ const result = await batch.send()
 // Returns the first found collection matching the specified filter.
 🔐 pb.collections.getFirstListItem(filter, options = {});
 
-// Returns a single collection by its id.
-🔐 pb.collections.getOne(id, options = {});
+// Returns a single collection by its id or name.
+🔐 pb.collections.getOne(idOrName, options = {});
 
 // Creates (aka. register) a new collection.
 🔐 pb.collections.create(bodyParams = {}, options = {});
 
-// Updates an existing collection by its id.
-🔐 pb.collections.update(id, bodyParams = {}, options = {});
+// Updates an existing collection by its id or name.
+🔐 pb.collections.update(idOrName, bodyParams = {}, options = {});
 
-// Deletes a single collection by its id.
-🔐 pb.collections.delete(id, options = {});
+// Deletes a single collection by its id or name.
+🔐 pb.collections.delete(idOrName, options = {});
+
+// Deletes all records associated with the specified collection.
+🔐 pb.collections.truncate(idOrName, options = {});
 
 // Imports the provided collections.
 🔐 pb.collections.import(collections, deleteMissing = false, options = {});

dist/pocketbase.cjs.d.ts

@@ -938,6 +938,12 @@ declare class CollectionService extends CrudService<CollectionModel> {
     getScaffolds(options?: CommonOptions): Promise<{
         [key: string]: CollectionModel;
     }>;
+    /**
+     * Deletes all records associated with the specified collection.
+     *
+     * @throws {ClientResponseError}
+     */
+    truncate(collectionIdOrName: string, options?: CommonOptions): Promise<true>;
 }
 interface HourlyStats {
     total: number;

dist/pocketbase.cjs.js

@@ -981,6 +981,12 @@ declare class CollectionService extends CrudService<CollectionModel> {
     getScaffolds(options?: CommonOptions): Promise<{
         [key: string]: CollectionModel;
     }>;
+    /**
+     * Deletes all records associated with the specified collection.
+     *
+     * @throws {ClientResponseError}
+     */
+    truncate(collectionIdOrName: string, options?: CommonOptions): Promise<true>;
 }
 interface HourlyStats {
     total: number;

dist/pocketbase.cjs.js.map

@@ -981,6 +981,12 @@ declare class CollectionService extends CrudService<CollectionModel> {
     getScaffolds(options?: CommonOptions): Promise<{
         [key: string]: CollectionModel;
     }>;
+    /**
+     * Deletes all records associated with the specified collection.
+     *
+     * @throws {ClientResponseError}
+     */
+    truncate(collectionIdOrName: string, options?: CommonOptions): Promise<true>;
 }
 interface HourlyStats {
     total: number;