Skip to content

Commit 087ce70

Browse files
Neelterminusdbgithub-actions[bot]
authored andcommitted
Apply docs changes
1 parent b68f339 commit 087ce70

File tree

3 files changed

+14
-13
lines changed

3 files changed

+14
-13
lines changed

docs/api/typedef.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ the DELETE document interface query parameters
113113
| [branch] | <code>string</code> | set branch to this id |
114114
| [ref] | <code>string</code> | set commit ref |
115115
| [default_branch_id] | <code>string</code> | set the default branch id |
116+
| [token] | <code>string</code> | Api token to connect with TerminusX |
116117

117118

118119
## RolesObj

docs/api/woql.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,6 @@ Syntactic sugar to allow writing WOQL.triple()... instead of new WOQLQuery().tri
99
Every function matches one of the public api functions of the woql query object
1010

1111

12-
## eval
13-
##### WOQL.eval ⇒ <code>WOQLQuery</code>
14-
Evaluates the passed arithmetic expression and generates or matches the result value
15-
16-
**Returns**: <code>WOQLQuery</code> - WOQLQuery
17-
18-
| Param | Type | Description |
19-
| --- | --- | --- |
20-
| arithExp | <code>object</code> \| <code>WOQLQuery</code> \| <code>string</code> | query or JSON-LD representing the query |
21-
| resultVarName | <code>string</code> | output variable |
22-
23-
2412
## using
2513
##### WOQL.using(refPath, subquery) ⇒ <code>WOQLQuery</code>
2614
Query running against any specific commit Id
@@ -531,6 +519,18 @@ let [result] = vars("result")
531519
evaluate(plus(2, minus(3, 1)), result)
532520
```
533521

522+
## eval
523+
##### WOQL.eval(arithExp, resultVarName) ⇒ <code>WOQLQuery</code>
524+
Evaluates the passed arithmetic expression and generates or matches the result value
525+
526+
**Returns**: <code>WOQLQuery</code> - WOQLQuery
527+
528+
| Param | Type | Description |
529+
| --- | --- | --- |
530+
| arithExp | <code>object</code> \| <code>WOQLQuery</code> \| <code>string</code> | query or JSON-LD representing the query |
531+
| resultVarName | <code>string</code> | output variable |
532+
533+
534534
## plus
535535
##### WOQL.plus(...args) ⇒ <code>WOQLQuery</code>
536536
Adds the numbers together

docs/api/woqlclient.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,7 @@ client.organization("admin")
339339
```
340340
341341
## getDatabases
342-
##### woqlClient.getDatabases() ⇒ <code>string</code> \| <code>boolean</code>
342+
##### woqlClient.getDatabases() ⇒ <code>Promise</code>
343343
Gets the organization's databases list.
344344
345345
If no organization has been set up, the function throws an exception

0 commit comments

Comments
 (0)