Skip to content

Export browser bundle of drivers as ECMAScript module #1038

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.

Sign up for GitHub

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 15 commits into from
Dec 21, 2022
Merged

Export browser bundle of drivers as ECMAScript module #1038

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
d24f4c2
Export browser bundle of drivers as ECMAScript module
bigmontz Dec 6, 2022
24dd10a
Add ESM module to driver
bigmontz Dec 7, 2022
676aca0
Remove browserify and babel depencency from the env
bigmontz Dec 8, 2022
5ab9d59
Remove un-used dependencies
bigmontz Dec 9, 2022
ca4e383
Remove babelify
bigmontz Dec 15, 2022
b5f2530
Remove browserify-transform-tools
bigmontz Dec 15, 2022
f0260e1
Remove browserify
bigmontz Dec 15, 2022
ea94e0c
Remove nyc and istanbul
bigmontz Dec 15, 2022
577acae
Add docs for import driver esm
bigmontz Dec 15, 2022
046640f
Ajust scripts
bigmontz Dec 15, 2022
df85fd9
Ajust testkit-backend package-json
bigmontz Dec 15, 2022
c38a4b2
Reformat
bigmontz Dec 16, 2022
7702beb
Revert changes in the neo4j-driver/tsconfig.json
bigmontz Dec 16, 2022
09eb86a
Sync deno
bigmontz Dec 16, 2022
d83ec5e
Remove jasmine.clock
bigmontz Dec 16, 2022
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
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,27 @@ var driver = neo4j.driver(
)
```

From `5.4.0`, this version is also exported as ECMA Script Module.
It can be imported from a module using the following statements:

```javascript
// Direct reference
import neo4j from 'lib/browser/neo4j-web.esm.min.js'

// unpkg CDN non-minified , version X.Y.Z where X.Y.Z >= 5.4.0
import neo4j from 'https://unpkg.com/browse/[email protected]/lib/browser/neo4j-web.esm.js'

// unpkg CDN minified for production use, version X.Y.Z where X.Y.Z >= 5.4.0
import neo4j from 'https://unpkg.com/browse/[email protected]/lib/browser/neo4j-web.esm.min.js'

// jsDelivr CDN non-minified, version X.Y.Z where X.Y.Z >= 5.4.0
import neo4j from 'https://cdn.jsdelivr.net/npm/[email protected]/lib/browser/neo4j-web.esm.js'

// jsDelivr CDN minified for production use, version X.Y.Z where X.Y.Z >= 5.4.0
import neo4j from 'https://cdn.jsdelivr.net/npm/[email protected]/lib/browser/neo4j-web.esm.min.js'

```

It is not required to explicitly close the driver on a web page. Web browser should gracefully close all open
WebSockets when the page is unloaded. However, driver instance should be explicitly closed when it's lifetime
is not the same as the lifetime of the web page:
Expand Down
Loading