intrn(manager): add note to the mechanism of archive batch

lemredd · Sep 15, 2022 · 3657864 · 3657864
1 parent b30eac6
commit 3657864
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/database/managers/base.ts b/database/managers/base.ts
@@ -232,6 +232,13 @@ export default abstract class Manager<
 		}
 	}
 
+	/**
+	 * Destroys or archives the models with the passed IDs.
+	 *
+	 * If the model is a paranoid, they will be archived which can be restored later.
+	 *
+	 * If the model is not paranoid, they will be deleetd permanently.
+	 */
 	async archiveBatch(IDs: X[]): Promise<number> {
 		try {
 			const destroyCount = await this.model.destroy(<DestroyOptions<T>>{