Skip to content

Commit 577acae

Browse files
committed
Add docs for import driver esm
1 parent ea94e0c commit 577acae

File tree

2 files changed

+42
-0
lines changed

2 files changed

+42
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,27 @@ var driver = neo4j.driver(
7878
)
7979
```
8080

81+
From `5.4.0`, this version is also exported as ECMA Script Module.
82+
It can be imported from a module using the following statements:
83+
84+
```javascript
85+
// Direct reference
86+
import neo4j from 'lib/browser/neo4j-web.esm.min.js'
87+
88+
// unpkg CDN non-minified , version X.Y.Z where X.Y.Z >= 5.4.0
89+
import neo4j from 'https://unpkg.com/browse/neo4j-driver@X.Y.Z/lib/browser/neo4j-web.esm.js'
90+
91+
// unpkg CDN minified for production use, version X.Y.Z where X.Y.Z >= 5.4.0
92+
import neo4j from 'https://unpkg.com/browse/neo4j-driver@X.Y.Z/lib/browser/neo4j-web.esm.min.js'
93+
94+
// jsDelivr CDN non-minified, version X.Y.Z where X.Y.Z >= 5.4.0
95+
import neo4j from 'https://cdn.jsdelivr.net/npm/neo4j-driver@X.Y.Z/lib/browser/neo4j-web.esm.js'
96+
97+
// jsDelivr CDN minified for production use, version X.Y.Z where X.Y.Z >= 5.4.0
98+
import neo4j from 'https://cdn.jsdelivr.net/npm/neo4j-driver@X.Y.Z/lib/browser/neo4j-web.esm.min.js'
99+
100+
```
101+
81102
It is not required to explicitly close the driver on a web page. Web browser should gracefully close all open
82103
WebSockets when the page is unloaded. However, driver instance should be explicitly closed when it's lifetime
83104
is not the same as the lifetime of the web page:

packages/neo4j-driver/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,27 @@ var driver = neo4j.driver(
7878
)
7979
```
8080

81+
From `5.4.0`, this version is also exported as ECMA Script Module.
82+
It can be imported from a module using the following statements:
83+
84+
```javascript
85+
// Direct reference
86+
import neo4j from 'lib/browser/neo4j-web.esm.min.js'
87+
88+
// unpkg CDN non-minified , version X.Y.Z where X.Y.Z >= 5.4.0
89+
import neo4j from 'https://unpkg.com/browse/neo4j-driver@X.Y.Z/lib/browser/neo4j-web.esm.js'
90+
91+
// unpkg CDN minified for production use, version X.Y.Z where X.Y.Z >= 5.4.0
92+
import neo4j from 'https://unpkg.com/browse/neo4j-driver@X.Y.Z/lib/browser/neo4j-web.esm.min.js'
93+
94+
// jsDelivr CDN non-minified, version X.Y.Z where X.Y.Z >= 5.4.0
95+
import neo4j from 'https://cdn.jsdelivr.net/npm/neo4j-driver@X.Y.Z/lib/browser/neo4j-web.esm.js'
96+
97+
// jsDelivr CDN minified for production use, version X.Y.Z where X.Y.Z >= 5.4.0
98+
import neo4j from 'https://cdn.jsdelivr.net/npm/neo4j-driver@X.Y.Z/lib/browser/neo4j-web.esm.min.js'
99+
100+
```
101+
81102
It is not required to explicitly close the driver on a web page. Web browser should gracefully close all open
82103
WebSockets when the page is unloaded. However, driver instance should be explicitly closed when it's lifetime
83104
is not the same as the lifetime of the web page:

0 commit comments

Comments
 (0)