Skip to content

Add docs for Javascript Driver Lite #732

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
May 4, 2021
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -480,6 +480,7 @@ var driver = neo4j.driver(
## Building

```
./buildDependencies.sh
npm install
npm run build
```
Expand Down
22 changes: 22 additions & 0 deletions bolt-connection/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Bolt connection module of the Neo4j Driver for JavaScript

This is a internal package shared by the `neo4j-driver` and the `neo4j-driver-lite` drivers. This pacakge is responsible for implements the [Bolt Protocol](https://7687.org/) using the `Connection` and `ConnectionProvider` interfaces defined by `neo4j-driver-core` package.

## Building

It's required to first build the `neo4j-driver-core` under the `../core` (see instruction on its folder). Then,

```
npm install
npm run build
```

This produces a Node.js module version under `lib/`.

## Testing

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:

```
npm run test::watch
```
20 changes: 20 additions & 0 deletions core/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Core module of the Neo4j Driver for JavaScript

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`.

## Building

```
npm install
npm run build
```

This produces a Node.js module version under `lib/`.

## Testing

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:

```
npm run test::watch
```
2 changes: 1 addition & 1 deletion esdoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
"enable": true
},
"brand": {
"title": "Neo4j Bolt Driver 4.1 for JavaScript",
"title": "Neo4j Bolt Driver 4.3 for JavaScript",
"repository": "https://github.com/neo4j/neo4j-javascript-driver"
}
}
Expand Down
Loading