Add @jsdoc for getBucketInfos

Issue: ARSN-447
scality · Nov 28, 2024 · 48b9b4f · 48b9b4f
1 parent f277590
commit 48b9b4f
Showing 1 changed file with 12 additions and 3 deletions.
diff --git a/lib/storage/metadata/mongoclient/MongoClientInterface.js b/lib/storage/metadata/mongoclient/MongoClientInterface.js
@@ -2114,9 +2114,18 @@ class MongoClientInterface {
         return name.startsWith('system.');
     }
 
-    /*
-     * get bucket related information for count items, used by cloudserver
-     * and s3utils
+    /**
+     * @typedef BucketInfos
+     * @property { int } bucketCount - number of buckets
+     * @property { BucketInfo[] } bucketInfos - array of bucket metadata
+     */
+
+    /**
+     * Get bucket related information for count items, used by cloudserver
+     * and s3utils.
+     * @param { Logger } log - Werelogs logger
+     * @param { function(error, BucketInfos): void } cb - callback
+     * @return { undefined }
      */
     getBucketInfos(log, cb) {
         let bucketCount = 0;