Update devel docs via 987d9e0

CHANGELOG.md

@@ -19,6 +19,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]
+
+### Added
+
+- Added the `versionAttribute` option to the document operation options types (DE-783)
+
 ## [8.8.0]
 
 ### Changed
@@ -1793,6 +1799,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/v8.8.0...HEAD
 [8.8.0]: https://github.com/arangodb/arangojs/compare/v8.7.0...v8.8.0
 [8.7.0]: https://github.com/arangodb/arangojs/compare/v8.6.0...v8.7.0
 [8.6.0]: https://github.com/arangodb/arangojs/compare/v8.5.0...v8.6.0

devel/types/collection.CollectionEdgesOptions.html

@@ -29,7 +29,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> allow<wbr/>Dirty<wbr/>
 request without distinguishing between leaders and followers.</p>
 </div></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in collection.ts:956</li></ul></aside></div>
+<li>Defined in collection.ts:977</li></ul></aside></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

devel/types/collection.CollectionEdgesResult.html

@@ -37,7 +37,7 @@ <h5>filtered<span class="tsd-signature-symbol">: </span><span class="tsd-signatu
 <li class="tsd-parameter">
 <h5>scanned<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in collection.ts:1336</li></ul></aside></div>
+<li>Defined in collection.ts:1357</li></ul></aside></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

devel/types/collection.CollectionImportOptions.html

@@ -61,7 +61,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> wait<wbr/>For<wbr/>Syn
 <div class="tsd-comment tsd-typography"><p>Whether to wait for the documents to have been synced to disk.</p>
 </div></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in collection.ts:911</li></ul></aside></div>
+<li>Defined in collection.ts:932</li></ul></aside></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

devel/types/collection.CollectionImportResult.html

@@ -51,7 +51,7 @@ <h5>updated<span class="tsd-signature-symbol">: </span><span class="tsd-signatur
 <div class="tsd-comment tsd-typography"><p>Number of documents updated.</p>
 </div></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in collection.ts:1302</li></ul></aside></div>
+<li>Defined in collection.ts:1323</li></ul></aside></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

devel/types/collection.CollectionInsertOptions.html

@@ -16,7 +16,7 @@
 <li><a href="../modules/collection.html">collection</a></li>
 <li><a href="collection.CollectionInsertOptions.html">CollectionInsertOptions</a></li></ul>
 <h1>Type alias CollectionInsertOptions</h1></div>
-<div class="tsd-signature">Collection<wbr/>Insert<wbr/>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>mergeObjects<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>overwriteMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;ignore&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;update&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;replace&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;conflict&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>refillIndexCaches<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>returnNew<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>returnOld<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>silent<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>waitForSync<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
+<div class="tsd-signature">Collection<wbr/>Insert<wbr/>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>mergeObjects<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>overwriteMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;ignore&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;update&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;replace&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;conflict&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>refillIndexCaches<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>returnNew<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>returnOld<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>silent<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>versionAttribute<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>waitForSync<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
 <div class="tsd-comment tsd-typography"><p>Options for inserting a new document into a collection.</p>
 </div>
 <div class="tsd-type-declaration">
@@ -63,6 +63,13 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> silent<span class="tsd
 <p>Default: <code>false</code></p>
 </div></li>
 <li class="tsd-parameter">
+<h5><code class="tsd-tag ts-flagOptional">Optional</code> version<wbr/>Attribute<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
+<div class="tsd-comment tsd-typography"><p>If set, the attribute with the name specified by the option is looked up
+in the stored document and the attribute value is compared numerically to
+the value of the versioning attribute in the supplied document that is
+supposed to update/replace it.</p>
+</div></li>
+<li class="tsd-parameter">
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> wait<wbr/>For<wbr/>Sync<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
 <div class="tsd-comment tsd-typography"><p>If set to <code>true</code>, data will be synchronized to disk before returning.</p>
 <p>Default: <code>false</code></p>

devel/types/collection.CollectionRemoveOptions.html

@@ -52,7 +52,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> wait<wbr/>For<wbr/>Syn
 <p>Default: <code>false</code></p>
 </div></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in collection.ts:872</li></ul></aside></div>
+<li>Defined in collection.ts:893</li></ul></aside></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

devel/types/collection.CollectionReplaceOptions.html

@@ -16,7 +16,7 @@
 <li><a href="../modules/collection.html">collection</a></li>
 <li><a href="collection.CollectionReplaceOptions.html">CollectionReplaceOptions</a></li></ul>
 <h1>Type alias CollectionReplaceOptions</h1></div>
-<div class="tsd-signature">Collection<wbr/>Replace<wbr/>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>ifMatch<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>ignoreRevs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>refillIndexCaches<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>returnNew<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>returnOld<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>silent<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>waitForSync<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
+<div class="tsd-signature">Collection<wbr/>Replace<wbr/>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>ifMatch<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>ignoreRevs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>refillIndexCaches<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>returnNew<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>returnOld<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>silent<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>versionAttribute<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>waitForSync<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
 <div class="tsd-comment tsd-typography"><p>Options for replacing an existing document in a collection.</p>
 </div>
 <div class="tsd-type-declaration">
@@ -59,12 +59,19 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> silent<span class="tsd
 <p>Default: <code>false</code></p>
 </div></li>
 <li class="tsd-parameter">
+<h5><code class="tsd-tag ts-flagOptional">Optional</code> version<wbr/>Attribute<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
+<div class="tsd-comment tsd-typography"><p>If set, the attribute with the name specified by the option is looked up
+in the stored document and the attribute value is compared numerically to
+the value of the versioning attribute in the supplied document that is
+supposed to update/replace it.</p>
+</div></li>
+<li class="tsd-parameter">
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> wait<wbr/>For<wbr/>Sync<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
 <div class="tsd-comment tsd-typography"><p>If set to <code>true</code>, data will be synchronized to disk before returning.</p>
 <p>Default: <code>false</code></p>
 </div></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in collection.ts:751</li></ul></aside></div>
+<li>Defined in collection.ts:758</li></ul></aside></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

devel/types/collection.CollectionUpdateOptions.html

@@ -16,7 +16,7 @@
 <li><a href="../modules/collection.html">collection</a></li>
 <li><a href="collection.CollectionUpdateOptions.html">CollectionUpdateOptions</a></li></ul>
 <h1>Type alias CollectionUpdateOptions</h1></div>
-<div class="tsd-signature">Collection<wbr/>Update<wbr/>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>ifMatch<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>ignoreRevs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>keepNull<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>mergeObjects<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>refillIndexCaches<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>returnNew<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>returnOld<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>silent<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>waitForSync<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
+<div class="tsd-signature">Collection<wbr/>Update<wbr/>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>ifMatch<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>ignoreRevs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>keepNull<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>mergeObjects<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>refillIndexCaches<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>returnNew<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>returnOld<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>silent<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>versionAttribute<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>waitForSync<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
 <div class="tsd-comment tsd-typography"><p>Options for updating a document in a collection.</p>
 </div>
 <div class="tsd-type-declaration">
@@ -72,12 +72,19 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> silent<span class="tsd
 <p>Default: <code>false</code></p>
 </div></li>
 <li class="tsd-parameter">
+<h5><code class="tsd-tag ts-flagOptional">Optional</code> version<wbr/>Attribute<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
+<div class="tsd-comment tsd-typography"><p>If set, the attribute with the name specified by the option is looked up
+in the stored document and the attribute value is compared numerically to
+the value of the versioning attribute in the supplied document that is
+supposed to update/replace it.</p>
+</div></li>
+<li class="tsd-parameter">
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> wait<wbr/>For<wbr/>Sync<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
 <div class="tsd-comment tsd-typography"><p>If set to <code>true</code>, data will be synchronized to disk before returning.</p>
 <p>Default: <code>false</code></p>
 </div></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in collection.ts:804</li></ul></aside></div>
+<li>Defined in collection.ts:818</li></ul></aside></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

devel/types/collection.SimpleQueryAllOptions.html

@@ -52,7 +52,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> ttl<span class="tsd-si
 <p>See also <a href="database.QueryOptions.html">QueryOptions</a>.</p>
 </div></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in collection.ts:1004</li></ul></aside></div>
+<li>Defined in collection.ts:1025</li></ul></aside></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

devel/types/collection.SimpleQueryByExampleOptions.html

@@ -47,7 +47,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> ttl<span class="tsd-si
 <p>See also <a href="database.QueryOptions.html">QueryOptions</a>.</p>
 </div></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in collection.ts:971</li></ul></aside></div>
+<li>Defined in collection.ts:992</li></ul></aside></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

devel/types/collection.SimpleQueryFulltextOptions.html

@@ -38,7 +38,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> skip<span class="tsd-s
 <div class="tsd-comment tsd-typography"><p>Number of documents to skip in the query.</p>
 </div></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in collection.ts:1137</li></ul></aside></div>
+<li>Defined in collection.ts:1158</li></ul></aside></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">