Skip to content

Commit 5df9cf8

Browse files
Signed-off-by: NeelParihar <[email protected]>
2 parents 0eaa231 + 6001719 commit 5df9cf8

File tree

5 files changed

+62
-46
lines changed

5 files changed

+62
-46
lines changed

README.md

Lines changed: 18 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
[![npm version](https://img.shields.io/npm/v/@terminusdb/terminusdb-client?logo=npm)](https://www.npmjs.com/package/@terminusdb/terminusdb-client)
1212
[![npm downloads](https://img.shields.io/npm/dw/@terminusdb/terminusdb-client?color=red&label=npm%20package&logo=npm&style=flat)](https://www.npmjs.com/package/@terminusdb/terminusdb-client)
1313

14-
> This repository is for the JavaScript package for TerminusDB and TerminusX. The
15-
> JavaScript package runs in the browser and on Node.js.
14+
> This repository is for the JavaScript client library for TerminusDB and
15+
> TerminusX.
1616
1717
[**TerminusDB**][terminusdb] is an [open-source][terminusdb-repo] graph database
1818
and document store. It allows you to link JSON documents in a powerful knowledge
@@ -30,50 +30,41 @@ TerminusX is in public beta and you can [sign up now][dashboard].
3030

3131
## Requirements
3232

33-
- [NodeJS 10+](https://nodejs.org/en/)
33+
- Node.js version 10+ if using the TerminusDB client library as a Node.js package
3434

3535
## Installation
3636

37-
TerminusDB Client JS package can be used as either a Node.js module available through the npm registry, or directly included in web-sites by including the script tag below.
37+
The TerminusDB JavaScript client library can be used either as a Node.js package
38+
or as a script that runs in the browser.
3839

39-
### NPM Module
40+
### NPM Package
4041

41-
Before installing, download and install Node.js.<br>
42-
NodeJS version 10.X or higher is required. NodeJS version 14.X is recommended.
42+
> :memo: If you don't already have Node.js installed, [install it][node-install] first.
4343
44-
Installation is done using the npm install command:
44+
[node-install]: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
4545

46-
Using npm we can install the package in a new NodeJs project or existing one using following commands:
46+
To install the `terminusdb-client` package as a dependency in an existing
47+
package, run:
4748

48-
Go to a NodeJs project folder:
49-
50-
```bash
51-
$ cd ../projectfolder/
52-
```
53-
54-
Install the package
55-
56-
```bash
49+
```sh
5750
$ npm install --save @terminusdb/terminusdb-client
5851
```
5952

60-
This command will add `@terminusdb/terminusdb-client` as a dependency to a package.json
53+
This command update your `package.json`.
6154

62-
### Minified Script
55+
### Script
6356

64-
Using cdn:
57+
To use the `terminusdb-client` script on a webpage sourced from a CDN, add this
58+
to your HTML:
6559

6660
```html
6761
<script src="https://unpkg.com/@terminusdb/terminusdb-client/dist/terminusdb-client.min.js"></script>
6862
```
6963

70-
Downloading:
64+
Alternatively, you can download the latest [`terminusdb-client.min.js`][js], add
65+
it to your sources, and use that in the `<script>` instead.
7166

72-
Download the terminusdb-client.min.js file from the /dist directory and save it to your location of choice, then:
73-
74-
```html
75-
<script src="http://my.saved.location/terminusdb-client.min.js"></script>
76-
```
67+
[js]: https://unpkg.com/@terminusdb/terminusdb-client/dist/terminusdb-client.min.js
7768

7869
## Usage
7970

RELEASE_NOTES.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1+
# TerminusDB Client v10.0.5
2+
3+
## New 🚀
4+
5+
* Add new [getDatabases](https://terminusdb.github.io/terminusdb-client-js/#/api/woqlClient.js?id=getdatabases) method [#121](/../../pull/121)
6+
* Add track version id [#116](/../../pull/116)
7+
8+
## Fixes 🛠
9+
10+
* Fixed tests [#123](/../../pull/123)
11+
* Modified AccessControl documentations, added api token [#124](/../../pull/124)
12+
* UPDATED packages [#126](/../../pull/126)
13+
14+
## Deprecated ☠️
15+
16+
* Deprecated connect function [#114](/../../pull/114)
17+
18+
---
19+
120
# TerminusDB Client v10.0.4
221

322
## New 🚀

docs/README.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
[![npm version](https://img.shields.io/npm/v/@terminusdb/terminusdb-client?logo=npm)](https://www.npmjs.com/package/@terminusdb/terminusdb-client)
1212
[![npm downloads](https://img.shields.io/npm/dw/@terminusdb/terminusdb-client?color=red&label=npm%20package&logo=npm&style=flat)](https://www.npmjs.com/package/@terminusdb/terminusdb-client)
1313

14-
> This repository is for the JavaScript client for TerminusDB and TerminusX. The
15-
> JavaScript client runs in the browser and on Node.js.
14+
> This repository is for the JavaScript client library for TerminusDB and
15+
> TerminusX.
1616
1717
[**TerminusDB**][terminusdb] is an [open-source][terminusdb-repo] graph database
1818
and document store. It allows you to link JSON documents in a powerful knowledge
@@ -30,40 +30,41 @@ TerminusX is in public beta and you can [sign up now][dashboard].
3030

3131
## Requirements
3232

33-
- [NodeJS 10+](https://nodejs.org/en/)
33+
- Node.js version 10+ if using the TerminusDB client library as a Node.js package
3434

3535
## Installation
3636

37-
TerminusDB Client can be used as either a Node.js module available through the npm registry, or directly included in web-sites by including the script tag below.
37+
The TerminusDB JavaScript client library can be used either as a Node.js package
38+
or as a script that runs in the browser.
3839

39-
### NPM Module
40+
### NPM Package
4041

41-
Before installing, download and install Node.js.<br>
42-
NodeJS version 10.X or higher is required. NodeJS version 14.X is recommended.
42+
> :memo: If you don't already have Node.js installed, [install it][node-install] first.
4343
44-
Installation is done using the npm install command:
44+
[node-install]: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
4545

46-
Using npm:
46+
To install the `terminusdb-client` package as a dependency in an existing
47+
package, run:
4748

48-
```bash
49+
```sh
4950
$ npm install --save @terminusdb/terminusdb-client
5051
```
5152

52-
### Minified Script
53+
This command update your `package.json`.
5354

54-
Using cdn:
55+
### Script
56+
57+
To use the `terminusdb-client` script on a webpage sourced from a CDN, add this
58+
to your HTML:
5559

5660
```html
5761
<script src="https://unpkg.com/@terminusdb/terminusdb-client/dist/terminusdb-client.min.js"></script>
5862
```
5963

60-
Downloading:
61-
62-
Download the terminusdb-client.min.js file from the /dist directory and save it to your location of choice, then:
64+
Alternatively, you can download the latest [`terminusdb-client.min.js`][js], add
65+
it to your sources, and use that in the `<script>` instead.
6366

64-
```html
65-
<script src="http://my.saved.location/terminusdb-client.min.js"></script>
66-
```
67+
[js]: https://unpkg.com/@terminusdb/terminusdb-client/dist/terminusdb-client.min.js
6768

6869
## Usage
6970

lib/dispatchRequest.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ function DispatchRequest(url, action, payload, local_auth, remote_auth = null, c
4747
mode: 'cors', // no-cors, cors, *same-origin
4848
redirect: 'follow', // manual, *follow, error
4949
referrer: 'client',
50+
maxContentLength: Infinity,
51+
maxBodyLength: Infinity,
5052
headers:{}
5153
// url:url,
5254
// no-referrer, *client

package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@terminusdb/terminusdb-client",
3-
"version": "10.0.4",
3+
"version": "10.0.5",
44
"description": "TerminusDB client library",
55
"main": "index.js",
66
"types": "./dist/typescript/index.d.ts",
@@ -20,6 +20,9 @@
2020
"author": "[email protected]",
2121
"license": "Apache-2.0",
2222
"dependencies": {
23+
"pathval":">=1.1.1",
24+
"ajv":">=6.12.3",
25+
"follow-redirects":">=1.14.8",
2326
"axios": ">=0.25.0",
2427
"babel-polyfill": "^6.26.0",
2528
"node-forge": ">=1.0.0",

0 commit comments

Comments
 (0)