Add ignoreRevs to RemoveDocumentOptions

Fixes DE-947.

Author: pluma

CHANGELOG.md

@@ -14,6 +14,14 @@ 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]
+
+### Added
+
+- Added `ignoreRevs` option to `RemoveDocumentOptions` type (DE-947)
+
+  This affects the `collection.remove` and `collection.removeAll` methods.
+
 ## [10.0.0] - 2025-01-06
 
 This is a major release and breaks backwards compatibility.
@@ -2452,6 +2460,7 @@ For a detailed list of changes between pre-release versions of v7 see the
 
   Graph methods now only return the relevant part of the response body.
 
+[unreleased]: https://github.com/arangodb/arangojs/compare/v10.0.0...HEAD
 [10.0.0]: https://github.com/arangodb/arangojs/compare/v9.3.0...v10.0.0
 [9.3.0]: https://github.com/arangodb/arangojs/compare/v9.2.0...v9.3.0
 [9.2.0]: https://github.com/arangodb/arangojs/compare/v9.1.0...v9.2.0

src/documents.ts

@@ -372,6 +372,13 @@ export type RemoveDocumentOptions = {
    * Default: `false`
    */
   waitForSync?: boolean;
+  /**
+   * If set to `false`, the existing document will only be modified if its
+   * `_rev` property matches the same property on the new data.
+   *
+   * Default: `true`
+   */
+  ignoreRevs?: boolean;
   /**
    * If set to `true`, the complete old document will be returned as the `old`
    * property on the result object. Has no effect if `silent` is set to `true`.
@@ -573,7 +580,7 @@ export type ObjectWithDocumentKey = {
 export function _documentHandle(
   selector: DocumentSelector,
   collectionName: string,
-  strict: boolean = true,
+  strict: boolean = true
 ): string {
   if (typeof selector !== "string") {
     if (selector._id) {
@@ -583,14 +590,14 @@ export function _documentHandle(
       return _documentHandle(selector._key, collectionName);
     }
     throw new Error(
-      "Document handle must be a string or an object with a _key or _id attribute",
+      "Document handle must be a string or an object with a _key or _id attribute"
     );
   }
   if (selector.includes("/")) {
     const [head] = selector.split("/");
     if (strict && head !== collectionName) {
       throw new Error(
-        `Document ID "${selector}" does not match collection name "${collectionName}"`,
+        `Document ID "${selector}" does not match collection name "${collectionName}"`
       );
     }
     return selector;