Fix Driver.getServerInfo api docs (#1103)

bigmontz · web-flow · commit 116a4dee94a4 · 2023-06-27T14:02:39.000+02:00
diff --git a/packages/core/src/driver.ts b/packages/core/src/driver.ts
@@ -614,7 +614,7 @@ class Driver {
    *
    * @param {Object} param - The object parameter
    * @param {string} param.database - The target database to verify connectivity for.
-   * @returns {Promise<void>} promise resolved with void or rejected with error.
+   * @returns {Promise<ServerInfo>} promise resolved with the ServerInfo or rejected with error.
    */
   getServerInfo ({ database = '' }: { database?: string } = {}): Promise<ServerInfo> {
     const connectionProvider = this._getOrCreateConnectionProvider()
diff --git a/packages/neo4j-driver-deno/lib/core/driver.ts b/packages/neo4j-driver-deno/lib/core/driver.ts
@@ -614,7 +614,7 @@ class Driver {
    *
    * @param {Object} param - The object parameter
    * @param {string} param.database - The target database to verify connectivity for.
-   * @returns {Promise<void>} promise resolved with void or rejected with error.
+   * @returns {Promise<ServerInfo>} promise resolved with the ServerInfo or rejected with error.
    */
   getServerInfo ({ database = '' }: { database?: string } = {}): Promise<ServerInfo> {
     const connectionProvider = this._getOrCreateConnectionProvider()

Original file line number	Diff line number	Diff line change
`@@ -614,7 +614,7 @@ class Driver {`
`614`	`614`	`*`
`615`	`615`	`* @param {Object} param - The object parameter`
`616`	`616`	`* @param {string} param.database - The target database to verify connectivity for.`
`617`		`- * @returns {Promise<void>} promise resolved with void or rejected with error.`
	`617`	`+ * @returns {Promise<ServerInfo>} promise resolved with the ServerInfo or rejected with error.`
`618`	`618`	`*/`
`619`	`619`	`getServerInfo ({ database = '' }: { database?: string } = {}): Promise<ServerInfo> {`
`620`	`620`	`const connectionProvider = this._getOrCreateConnectionProvider()`