Skip to content

Commit c9e3e6c

Browse files
authored
Add docs for Javascript Driver Lite (#732)
Updating docs
1 parent e033b24 commit c9e3e6c

File tree

8 files changed

+521
-2
lines changed

8 files changed

+521
-2
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -480,6 +480,7 @@ var driver = neo4j.driver(
480480
## Building
481481

482482
```
483+
./buildDependencies.sh
483484
npm install
484485
npm run build
485486
```

bolt-connection/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Bolt connection module of the Neo4j Driver for JavaScript
2+
3+
This is an internal package shared by the `neo4j-driver` and the `neo4j-driver-lite` drivers. This package is responsible for implementing the [Bolt Protocol](https://7687.org/) using the `Connection` and `ConnectionProvider` interfaces defined by `neo4j-driver-core` package.
4+
5+
## Building
6+
7+
It's required to first build the `neo4j-driver-core` under the `../core` (see instruction on its folder). Then,
8+
9+
```
10+
npm install
11+
npm run build
12+
```
13+
14+
This produces a Node.js module version under `lib/`.
15+
16+
## Testing
17+
18+
The tests can be executed by running `npm test`. For development, you can have the build tool rerun the tests each time you change the source code:
19+
20+
```
21+
npm run test::watch
22+
```

core/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Core module of the Neo4j Driver for JavaScript
2+
3+
This is a internal package shared by the `neo4j-driver` and the `neo4j-driver-lite` drivers. This package is responsible for high level pieces of the driver such as `Session`, `Result`, `Record`, some data types and the interface for `Connection` and `ConnectionProvider`.
4+
5+
## Building
6+
7+
```
8+
npm install
9+
npm run build
10+
```
11+
12+
This produces a Node.js module version under `lib/`.
13+
14+
## Testing
15+
16+
The tests could be executed by running `npm test`. For development, you can have the build tool rerun the tests each time you change the source code:
17+
18+
```
19+
npm run test::watch
20+
```

esdoc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
"enable": true
3737
},
3838
"brand": {
39-
"title": "Neo4j Bolt Driver 4.1 for JavaScript",
39+
"title": "Neo4j Bolt Driver 4.3 for JavaScript",
4040
"repository": "https://github.com/neo4j/neo4j-javascript-driver"
4141
}
4242
}

0 commit comments

Comments
 (0)