-
Notifications
You must be signed in to change notification settings - Fork 151
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
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
5ffba9a
Add docs for Javascript Driver Lite
bigmontz be18b89
Update version.ts on versionRelease
bigmontz d885391
update test instructions
bigmontz e9ca7a8
Update docs about bolt-connection and core
bigmontz e4d00f3
Update bolt-connection/README.md
bigmontz 6aefe33
Update bolt-connection/README.md
bigmontz cf90fa1
Update neo4j-driver-lite/README.md
bigmontz 076f3b2
Update neo4j-driver-lite/README.md
bigmontz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -480,6 +480,7 @@ var driver = neo4j.driver( | |
## Building | ||
|
||
``` | ||
./buildDependencies.sh | ||
npm install | ||
npm run build | ||
``` | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: | ||
bigmontz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
``` | ||
npm run test::watch | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.