Fix #802

arangodb · Feb 14, 2024 · 9de7404 · 9de7404
1 parent 352267f
commit 9de7404
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,12 @@ This driver uses semantic versioning:
 - A change in the major version (e.g. 1.Y.Z -> 2.0.0) indicates _breaking_
   changes that require changes in your code to upgrade.
 
+## [Unreleased]
+
+### Changed
+
+- Made `options` argument in `collection.edges`, `inEdges` and `outEdges` optional ([#802](https://github.com/arangodb/arangojs/issues/802))
+
 ## [8.6.0] - 2023-10-24
 
 ### Added

diff --git a/src/collection.ts b/src/collection.ts
@@ -3343,7 +3343,7 @@ export interface EdgeCollection<T extends Record<string, any> = any>
    */
   edges(
     selector: DocumentSelector,
-    options: CollectionEdgesOptions
+    options?: CollectionEdgesOptions
   ): Promise<ArangoApiResponse<CollectionEdgesResult<T>>>;
   /**
    * Retrieves a list of all incoming edges of the document matching the given
@@ -3372,7 +3372,7 @@ export interface EdgeCollection<T extends Record<string, any> = any>
    */
   inEdges(
     selector: DocumentSelector,
-    options: CollectionEdgesOptions
+    options?: CollectionEdgesOptions
   ): Promise<ArangoApiResponse<CollectionEdgesResult<T>>>;
   /**
    * Retrieves a list of all outgoing edges of the document matching the given
@@ -3401,7 +3401,7 @@ export interface EdgeCollection<T extends Record<string, any> = any>
    */
   outEdges(
     selector: DocumentSelector,
-    options: CollectionEdgesOptions
+    options?: CollectionEdgesOptions
   ): Promise<ArangoApiResponse<CollectionEdgesResult<T>>>;
 
   /**
@@ -3908,7 +3908,7 @@ export class Collection<T extends Record<string, any> = any>
   //#region edges
   protected _edges(
     selector: DocumentSelector,
-    options: CollectionEdgesOptions,
+    options: CollectionEdgesOptions = {},
     direction?: "in" | "out"
   ) {
     const { allowDirtyRead = undefined } = options;
@@ -3922,15 +3922,15 @@ export class Collection<T extends Record<string, any> = any>
     });
   }
 
-  edges(vertex: DocumentSelector, options: CollectionEdgesOptions) {
+  edges(vertex: DocumentSelector, options?: CollectionEdgesOptions) {
     return this._edges(vertex, options);
   }
 
-  inEdges(vertex: DocumentSelector, options: CollectionEdgesOptions) {
+  inEdges(vertex: DocumentSelector, options?: CollectionEdgesOptions) {
     return this._edges(vertex, options, "in");
   }
 
-  outEdges(vertex: DocumentSelector, options: CollectionEdgesOptions) {
+  outEdges(vertex: DocumentSelector, options?: CollectionEdgesOptions) {
     return this._edges(vertex, options, "out");
   }