Fix #728

Author: pluma

CHANGELOG.md

@@ -34,6 +34,8 @@ This driver uses semantic versioning:
 
 - Added `collection.documents` for fetching multiple documents
 
+- Added missing `details` flag to `collection.figures` [#728](https://github.com/arangodb/arangojs/issues/728)
+
 - Added support for `fillBlockCache` query option
 
 - Added User Management API [#664](https://github.com/arangodb/arangojs/issues/664)

src/collection.ts

@@ -1372,6 +1372,9 @@ export interface DocumentCollection<T extends Record<string, unknown> = any>
   /**
    * Retrieves statistics for a collection.
    *
+   * @param details - whether to return extended storage engine-specific details
+   * to the figures, which may cause additional load and impact performance
+   *
    * @example
    * ```js
    * const db = new Database();
@@ -1380,7 +1383,9 @@ export interface DocumentCollection<T extends Record<string, unknown> = any>
    * // data contains the collection's figures
    * ```
    */
-  figures(): Promise<
+  figures(
+    details?: boolean
+  ): Promise<
     ArangoResponseMetadata &
       CollectionMetadata &
       CollectionProperties & { count: number; figures: Record<string, any> }
@@ -3430,14 +3435,19 @@ export class Collection<T extends Record<string, unknown> = any>
     return body.result;
   }
 
-  figures() {
-    return this._get<
-      CollectionMetadata &
-        CollectionProperties & {
-          count: number;
-          figures: Record<string, any>;
-        }
-    >("figures");
+  figures(
+    details = false
+  ): Promise<
+    CollectionMetadata &
+      CollectionProperties & {
+        count: number;
+        figures: Record<string, any>;
+      } & ArangoResponseMetadata
+  > {
+    return this._db.request({
+      path: `/_api/collection/${this._name}/figures`,
+      qs: { details },
+    });
   }
 
   revision() {