Add DocumentSaveOptions (#546)

- Add type `DocumentSaveOptions` for `opts` in `DocumentCollection#save`
- Add param `opts` of type `DocumentSaveOptions` in `EdgeCollection#save`

Author: mpv1989

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Added
+
+- Added type `DocumentSaveOptions` for `opts` in `DocumentCollection#save`
+
+- Added param `opts` of type `DocumentSaveOptions` in `EdgeCollection#save`
+
 ## [6.3.0] - 2018-06-20
 
 ### Added

docs/Drivers/JS/Reference/Collection/DocumentCollection.md

@@ -72,12 +72,23 @@ the document's metadata.
     If set to `true`, return additionally the complete new documents under the
     attribute `new` in the result.
 
+  * **returnOld**: `boolean` (Default: `false)
+
+    If set to `true`, return additionally the complete old documents under the
+    attribute `old` in the result.
+
   * **silent**: `boolean` (Default: `false`)
 
     If set to true, an empty object will be returned as response. No meta-data
     will be returned for the created document. This option can be used to save
     some network traffic.
 
+  * **overwrite**: `boolean` (Default: `false`)
+
+    If set to true, the insert becomes a replace-insert. If a document with the
+    same _key already exists the new document is not rejected with unique
+    constraint violated but will replace the old document.
+
 If a boolean is passed instead of an options object, it will be interpreted as
 the _returnNew_ option.
 

docs/Drivers/JS/Reference/Collection/EdgeCollection.md

@@ -62,6 +62,39 @@ _data_ and returns an object containing the edge's metadata.
   document in the database, the `_key` of an edge in the collection, or a
   document (i.e. an object with an `_id` or `_key` property).
 
+* **opts**: `Object` (optional)
+
+  If _opts_ is set, it must be an object with any of the following properties:
+
+  * **waitForSync**: `boolean` (Default: `false`)
+
+    Wait until document has been synced to disk.
+
+  * **returnNew**: `boolean` (Default: `false`)
+
+    If set to `true`, return additionally the complete new documents under the
+    attribute `new` in the result.
+
+  * **returnOld**: `boolean` (Default: `false)
+
+    If set to `true`, return additionally the complete old documents under the
+    attribute `old` in the result.
+
+  * **silent**: `boolean` (Default: `false`)
+
+    If set to true, an empty object will be returned as response. No meta-data
+    will be returned for the created document. This option can be used to save
+    some network traffic.
+
+  * **overwrite**: `boolean` (Default: `false`)
+
+    If set to true, the insert becomes a replace-insert. If a document with the
+    same _key already exists the new document is not rejected with unique
+    constraint violated but will replace the old document.
+
+If a boolean is passed instead of an options object, it will be interpreted as
+the _returnNew_ option.
+
 **Examples**
 
 ```js

src/collection.ts

@@ -634,6 +634,14 @@ export abstract class BaseCollection implements ArangoCollection {
   }
 }
 
+export interface DocumentSaveOptions {
+  waitForSync?: boolean;
+  returnNew?: boolean;
+  returnOld?: boolean;
+  overwrite?: boolean;
+  silent?: boolean;
+}
+
 export class DocumentCollection extends BaseCollection {
   type = Types.DOCUMENT_COLLECTION;
   constructor(connection: Connection, name: string) {
@@ -651,7 +659,7 @@ export class DocumentCollection extends BaseCollection {
     );
   }
 
-  save(data: any, opts?: any) {
+  save(data: any, opts?: DocumentSaveOptions | boolean) {
     if (typeof opts === "boolean") {
       opts = { returnNew: opts };
     }
@@ -704,12 +712,27 @@ export class EdgeCollection extends BaseCollection {
     );
   }
 
-  save(data: any): Promise<any>;
-  save(data: any, fromId: DocumentHandle, toId: DocumentHandle): Promise<any>;
-  save(data: any, fromId?: DocumentHandle, toId?: DocumentHandle) {
-    if (fromId !== undefined) {
-      data._from = this._documentHandle(fromId);
+  save(data: any, opts?: DocumentSaveOptions | boolean): Promise<any>;
+  save(
+    data: any,
+    fromId: DocumentHandle,
+    toId: DocumentHandle,
+    opts?: DocumentSaveOptions | boolean
+  ): Promise<any>;
+  save(
+    data: any,
+    fromIdOrOpts?: DocumentHandle | DocumentSaveOptions | boolean,
+    toId?: DocumentHandle,
+    opts?: DocumentSaveOptions | boolean
+  ) {
+    if (toId !== undefined) {
+      data._from = this._documentHandle(fromIdOrOpts as DocumentHandle);
       data._to = this._documentHandle(toId!);
+    } else if (fromIdOrOpts !== undefined) {
+      opts = fromIdOrOpts as DocumentSaveOptions | boolean;
+    }
+    if (typeof opts === "boolean") {
+      opts = { returnNew: opts };
     }
     if (this._connection.arangoMajor <= 2) {
       return this._connection.request(
@@ -718,6 +741,7 @@ export class EdgeCollection extends BaseCollection {
           path: "/_api/edge",
           body: data,
           qs: {
+            ...opts,
             collection: this.name,
             from: data._from,
             to: data._to