Skip to content

Commit a1ee58e

Browse files
authored
Update api docs generation scripts (#806)
1 parent d72e43b commit a1ee58e

File tree

6 files changed

+9
-7
lines changed

6 files changed

+9
-7
lines changed

package.json

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
"scripts": {
88
"clean": "lerna clean -y && lerna run clean",
99
"build": "lerna bootstrap --ci",
10+
"docs": "lerna run docs --stream --concurrency 1",
1011
"test::unit": "lerna run test::unit --stream",
1112
"test::integration": "lerna run test::integration --stream",
1213
"test::browser": "lerna run test::browser --stream",

packages/core/src/session.ts

+3-1
Original file line numberDiff line numberDiff line change
@@ -358,10 +358,12 @@ class Session {
358358
}
359359

360360
/**
361+
* Sets the resolved database name in the session context.
361362
* @private
362363
* @param {string|undefined} database The resolved database name
364+
* @returns {void}
363365
*/
364-
_onDatabaseNameResolved(database?: string): void{
366+
_onDatabaseNameResolved(database?: string): void {
365367
if (!this._databaseNameResolved) {
366368
const normalizedDatabase = database || ''
367369
this._database = normalizedDatabase

packages/neo4j-driver-lite/esdoc.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,13 @@
3636
"enable": false
3737
},
3838
"brand": {
39-
"title": "Neo4j Bolt Driver 4.3 for JavaScript",
39+
"title": "Neo4j Bolt Driver 4.4 for JavaScript",
4040
"repository": "https://github.com/neo4j/neo4j-javascript-driver"
4141
}
4242
}
4343
},
4444
{
45-
"name": "../docs/embed-docs.plugin.js",
45+
"name": "../neo4j-driver/docs/embed-docs.plugin.js",
4646
"option": {
4747
"enabled": true,
4848
"path": "../core/docs"

packages/neo4j-driver-lite/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"version::set_version.ts": "sed 's/0.0.0-dev/'$VERSION'/g' src/version.ts > src/version.tmp && mv src/version.tmp src/version.ts",
1818
"versionRelease": "npm version $VERSION --no-git-tag-version && npm run version::set_version.ts",
1919
"build::es6": "tsc --target ES6 --outdir lib6",
20-
"predocs": "cd ../core && npm run docs && cd ../neo4j-driver-lite && npm run build && npm run build::es6",
20+
"predocs": "npm run build && npm run build::es6",
2121
"docs": "esdoc -c esdoc.json",
2222
"prepare": "npm run build && npm run build:browser",
2323
"clean": "rm -fr node_modules lib types"

packages/neo4j-driver/esdoc.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
"enable": true
3737
},
3838
"brand": {
39-
"title": "Neo4j Bolt Driver 4.3 for JavaScript",
39+
"title": "Neo4j Bolt Driver 4.4 for JavaScript",
4040
"repository": "https://github.com/neo4j/neo4j-javascript-driver"
4141
}
4242
}
@@ -45,7 +45,7 @@
4545
"name": "./docs/embed-docs.plugin.js",
4646
"option": {
4747
"enabled": true,
48-
"path": "./core/docs"
48+
"path": "../core/docs"
4949
}
5050
}
5151
]

packages/neo4j-driver/package.json

-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
"stop-neo4j": "gulp stop-neo4j",
2222
"run-stress-tests": "gulp run-stress-tests-without-jasmine",
2323
"run-ts-declaration-tests": "gulp run-ts-declaration-tests",
24-
"predocs": "cd core && npm run docs",
2524
"docs": "esdoc -c esdoc.json",
2625
"versionRelease": "gulp set --x $VERSION && npm version $VERSION --no-git-tag-version",
2726
"browser": "gulp browser && gulp test-browser",

0 commit comments

Comments
 (0)