Skip to content

Commit a442e84

Browse files
Apply docs changes
1 parent a344bfe commit a442e84

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/api/woqlclient.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1123,7 +1123,7 @@ async funtion callGetUserOrganizations(){
11231123
```
11241124
11251125
## getDiff
1126-
##### woqlClient.getDiff(before, after) ⇒ <code>Promise</code>
1126+
##### woqlClient.getDiff(before, after, options) ⇒ <code>Promise</code>
11271127
Get the patch of difference between two documents.
11281128
11291129
**Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.
@@ -1132,6 +1132,7 @@ Get the patch of difference between two documents.
11321132
| --- | --- | --- |
11331133
| before | <code>object</code> | The current state of JSON document |
11341134
| after | <code>object</code> | The updated state of JSON document |
1135+
| options | <code>object</code> | [{}] - Options to send to the diff endpoint |
11351136
11361137
**Example**
11371138
```javascript
@@ -1142,7 +1143,7 @@ const diff = await client.getDiff(
11421143
```
11431144
11441145
## getVersionObjectDiff
1145-
##### woqlClient.getVersionObjectDiff(id, beforeVersion, after) ⇒ <code>Promise</code>
1146+
##### woqlClient.getVersionObjectDiff(id, beforeVersion, after, options) ⇒ <code>Promise</code>
11461147
Get the patch of difference between two documents.
11471148
11481149
**Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.
@@ -1152,6 +1153,7 @@ Get the patch of difference between two documents.
11521153
| id | <code>string</code> | The object id to be diffed |
11531154
| beforeVersion | <code>string</code> | The version from which to compare the object |
11541155
| after | <code>object</code> | The updated state of JSON document |
1156+
| options | <code>object</code> | [{}] - Options to send to the diff endpoint |
11551157
11561158
**Example**
11571159
```javascript
@@ -1163,7 +1165,7 @@ const diff = await client.getVersionObjectDiff(
11631165
```
11641166
11651167
## getVersionDiff
1166-
##### woqlClient.getVersionDiff(id, beforeVersion, afterVersion) ⇒ <code>Promise</code>
1168+
##### woqlClient.getVersionDiff(id, beforeVersion, afterVersion, options) ⇒ <code>Promise</code>
11671169
Get the patch of difference between two documents.
11681170
11691171
**Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.
@@ -1173,6 +1175,7 @@ Get the patch of difference between two documents.
11731175
| id | <code>string</code> | The object id to be diffed |
11741176
| beforeVersion | <code>string</code> | The version from which to compare the object |
11751177
| afterVersion | <code>string</code> | The version to which to compare the object |
1178+
| options | <code>object</code> | [{}] - Options to send to the diff endpoint |
11761179
11771180
**Example**
11781181
```javascript

0 commit comments

Comments
 (0)