You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://twitter.com/TerminusDB)
[](https://www.npmjs.com/package/@terminusdb/terminusdb-client)
[](https://twitter.com/TerminusDB)
[](https://www.npmjs.com/package/@terminusdb/terminusdb-client)
@@ -132,13 +144,13 @@ const client = new TerminusClient.WOQLClient("http://127.0.0.1:6363/", {
132
144
133
145
## API
134
146
135
-
The API is documented at: https://terminusdb.com/docs/reference/js-client/core/#terminusdb-client-api
147
+
The API of the most recent release is documented at: <https://terminusdb.com/docs/v10.0/#/reference/reference-api>
136
148
137
149
## Report Issues
138
150
139
151
If you have encounter any issues, please report it with your os and environment setup, version that you are using and a simple reproducible case.
140
152
141
-
If you encounter other questions, you can ask in our community [forum](https://community.terminusdb.com/) or [Slack channel](http://bit.ly/terminusdb-slack).
153
+
If you encounter other questions, you can ask in our [Discord Server](https://discord.gg/hTU3XWSzuZ).
142
154
143
155
## Contribute
144
156
@@ -150,4 +162,4 @@ Please check [Contributing.md](Contributing.md) for more information.
Copy file name to clipboardExpand all lines: docs/api/typedef.js.md
+67-62Lines changed: 67 additions & 62 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,65 +1,70 @@
1
-
## Typedefs
2
-
## DocParamsGet
3
-
#### DocParamsGet : <code>Object</code>
1
+
2
+
## TypeDef
3
+
#### TypeDef
4
+
Type definations
5
+
6
+
7
+
### DocParamsGet
8
+
#### DocParamsGet: ` Object`
4
9
the GET document interface query parameters
5
10
6
11
**Properties**
7
12
8
-
| Name | Type |Default |Description |
9
-
| --- | --- | --- | --- |
10
-
|[graph_type]| <code>string</code> |<code>"instance"</code> | instance|schema default value is instance. Used to switch between getting documents from the instance or the schema graph. |
11
-
|[type]| <code>string</code> ||only documents of the given type are returned. |
12
-
|[id]| <code>string</code> ||only the document with the given ID is returned. |
13
-
|[prefixed]| <code>boolean</code> |<code>true</code> | return IRIs using a prefixed notation wherever possible. If false, full IRIs are used. |
14
-
|[minimized]| <code>boolean</code> |<code>false</code> | return the documents with very little whitespace. Each json document will be on its own line. |
15
-
|[unfold]| <code>boolean</code> |<code>true</code> | any subdocuments contained in the returned document are returned too. If false, these are referred to by their ID instead. |
16
-
|[skip]| <code>number</code> |<code>0</code> | How many results to skip |
17
-
|[count]| <code>number</code> ||count - How many results to return. If this option is absent, all results are returned. |
18
-
|[as_list]| <code>boolean</code> |<code>false</code> | If true, don't return a stream of json objects, but a json list. |
19
-
|[graph_type]| <code>string</code> ||instance|schema default value is instance |
20
-
21
-
22
-
## DocParamsPost
23
-
#### DocParamsPost : <code>Object</code>
13
+
| Name | Type | Description |
14
+
| --- | --- | --- |
15
+
|[graph_type]| <code>GraphType</code> | instance|schema, default value is instance. Used to switch between getting documents from the instance or the schema graph. |
16
+
|[type]| <code>string</code> | only documents of the given type are returned. |
17
+
|[id]| <code>string</code> | only the document with the given ID is returned. |
18
+
|[prefixed]| <code>boolean</code> |default is true, return IRIs using a prefixed notation wherever possible. If false, full IRIs are used. |
19
+
|[minimized]| <code>boolean</code> |default is false, return the documents with very little whitespace. Each json document will be on its own line. |
20
+
|[unfold]| <code>boolean</code> |default is false, any subdocuments contained in the returned document are returned too. If false, these are referred to by their ID instead. |
21
+
|[skip]| <code>number</code> |default is 0, How many results to skip |
22
+
|[count]| <code>number</code> | count - How many results to return. If this option is absent, all results are returned. |
23
+
|[as_list]| <code>boolean</code> |default is false, If true, don't return a stream of json objects, but a json list. |
24
+
|[graph_type]| <code>string</code> | instance|schema default value is instance |
25
+
26
+
27
+
###DocParamsPost
28
+
#### DocParamsPost: `Object`
24
29
the POST document interface query parameters
25
30
26
31
**Properties**
27
32
28
-
| Name | Type |Default |Description |
29
-
| --- | --- | --- | --- |
30
-
|[graph_type]| <code>string</code> |<code>"instance"</code> | instance|schema Used to switch between getting documents from the instance or the schema graph. |
31
-
|[full_replace]| <code>boolean</code> |<code>false</code> | If true, all existing documents are deleted before inserting the posted documents. This allows the full replacement of the contents of a database. This is especially useful for replacing the schema. |
33
+
| Name | Type | Description |
34
+
| --- | --- | --- |
35
+
|[graph_type]| <code>GraphType</code> |default is instance instance|schema Used to switch between getting documents from the instance or the schema graph. |
36
+
|[full_replace]| <code>boolean</code> |default is false, If true, all existing documents are deleted before inserting the posted documents. This allows the full replacement of the contents of a database. This is especially useful for replacing the schema. |
32
37
33
38
34
-
## DocParamsPut
35
-
#### DocParamsPut : <code>Object</code>
39
+
###DocParamsPut
40
+
#### DocParamsPut: `Object`
36
41
the PUT document interface query parameters
37
42
38
43
**Properties**
39
44
40
-
| Name | Type |Default |Description |
41
-
| --- | --- | --- | --- |
42
-
|[graph_type]| <code>string</code> |<code>"instance"</code> | instance|schema Used to switch between getting documents from the instance or the schema graph. |
45
+
| Name | Type | Description |
46
+
| --- | --- | --- |
47
+
|[graph_type]| <code>GraphType</code> |default is instance, instance|schema Used to switch between getting documents from the instance or the schema graph. |
43
48
44
49
45
-
## DocParamsDelete
46
-
#### DocParamsDelete : <code>Object</code>
50
+
###DocParamsDelete
51
+
#### DocParamsDelete: `Object`
47
52
the DELETE document interface query parameters
48
53
49
54
**Properties**
50
55
51
-
| Name | Type |Default |Description |
52
-
| --- | --- | --- | --- |
53
-
|[graph_type]| <code>string</code> |<code>"instance"</code> | instance|schema Used to switch between getting documents from the instance or the schema graph. |
54
-
| id | <code>string</code> \| <code>array</code> ||a single id or a list of ids to delete. |
55
-
|[nuke]| <code>booleam</code> |<code>false</code> | If true, delete everything at this resource location (dangerous!). |
56
+
| Name | Type | Description |
57
+
| --- | --- | --- |
58
+
|[graph_type]| <code>GraphType</code> |default is instance, instance|schema Used to switch between getting documents from the instance or the schema graph. |
59
+
| id | <code>string</code> \| <code>array</code> | a single id or a list of ids to delete. |
60
+
|[nuke]| <code>booleam</code> |default is false, If true, delete everything at this resource location (dangerous!). |
Copy file name to clipboardExpand all lines: docs/api/woql.js.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -988,11 +988,11 @@ Orders the results of the contained subquery by a precedence list of variables
988
988
989
989
| Param | Type | Description |
990
990
| --- | --- | --- |
991
-
| ...varNames | <code>string</code> | A sequence of variables, by which to order the results, each optionally followed by either “asc” or “desc” to represent order |
991
+
| ...varNames | <code>string</code> | A sequence of variables, by which to order the results, each optionally followed by either “asc” or “desc” to represent order as a list, by default it will sort the variable in ascending order |
Retrieves a list of databases (id, organization, label, comment) that the current user has access to on the server. Note that this requires the client to call connect() first.
347
+
348
+
**Returns**: <code>array</code> - the user databases list
349
+
350
+
| Param | Type | Description |
351
+
| --- | --- | --- |
352
+
| [orgList] | <code>array</code> | a list of databases the user has access to on the server, each having: |
0 commit comments