Fix #740

Author: pluma

CHANGELOG.md

@@ -38,6 +38,10 @@ This driver uses semantic versioning:
 
 - Added support for `fillBlockCache` query option
 
+- Added support for passing `Graph` objects in AQL queries [#740](https://github.com/arangodb/arangojs/issues/740)
+
+  This also adds the `isArangoGraph` helper function for type checking.
+
 - Added User Management API [#664](https://github.com/arangodb/arangojs/issues/664)
 
   This implements the endpoints of the

src/aql.ts

@@ -11,6 +11,7 @@
  * @packageDocumentation
  */
 import { ArangoCollection, isArangoCollection } from "./collection";
+import { Graph, isArangoGraph } from "./graph";
 import { isArangoView, View } from "./view";
 
 /**
@@ -70,6 +71,7 @@ export interface AqlLiteral {
 export type AqlValue =
   | ArangoCollection
   | View
+  | Graph
   | GeneratedAqlQuery
   | AqlLiteral
   | string
@@ -241,7 +243,11 @@ export function aql(
     const index = bindValues.indexOf(rawValue);
     const isKnown = index !== -1;
     let name = `value${isKnown ? index : bindValues.length}`;
-    if (isArangoCollection(rawValue) || isArangoView(rawValue)) {
+    if (
+      isArangoCollection(rawValue) ||
+      isArangoGraph(rawValue) ||
+      isArangoView(rawValue)
+    ) {
       name = `@${name}`;
       value = rawValue.name;
     }

src/graph.ts

@@ -35,6 +35,15 @@ import {
 import { isArangoError } from "./error";
 import { DOCUMENT_NOT_FOUND, GRAPH_NOT_FOUND } from "./lib/codes";
 
+/**
+ * Indicates whether the given value represents a {@link Graph}.
+ *
+ * @param graph - A value that might be a Graph.
+ */
+export function isArangoGraph(graph: any): graph is Graph {
+  return Boolean(graph && graph.isArangoGraph);
+}
+
 /**
  * @internal
  * @hidden
@@ -1200,6 +1209,15 @@ export class Graph {
     this._db = db;
   }
 
+  /**
+   * @internal
+   *
+   * Indicates that this object represents an ArangoDB Graph.
+   */
+  get isArangoGraph(): true {
+    return true;
+  }
+
   /**
    * Name of the graph.
    */