neo4j-driver-bolt-connection
Version:
Implements the connection with the Neo4j Database using the Bolt Protocol
35 lines (21 loc) • 1.25 kB
Markdown
# Bolt connection module of the Neo4j Driver for JavaScript
> :warning: **This package is not intended to be used by end users, it contains the basic tools used by the `neo4j-driver` to connect to `Neo4j`.**
This is an internal package shared by the [neo4j-driver](https://www.npmjs.com/package/neo4j-driver) and the [neo4j-driver-lite](https://www.npmjs.com/package/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.
## Building
The build of this package is handled by the root package of this repository.
First it is needed to install the mono-repo dependencies by running `npm ci` in the root of the repository. Then:
* Build all could be performed with
```
npm run build
```
* Build only the Core could be performed with
Builind only Core:
```
npm run build -- --scope=neo4j-driver-bolt-connection
```
This produces a Node.js module version under `lib/`.
## Testing
The tests could be executed by running `npm test` in this package folder. For development, you can have the build tool rerun the tests each time you change the source code:
```
npm run test::watch
```