Small JSDoc improvements

 * refined some type definitions
 * fixed couple links
 * made internal functions private

Author: lutovich

src/v1/driver.js

@@ -26,8 +26,8 @@ import {DirectConnectionProvider} from './internal/connection-providers';
 
 const READ = 'READ', WRITE = 'WRITE';
 /**
- * A driver maintains one or more {@link Session sessions} with a remote
- * Neo4j instance. Through the {@link Session sessions} you can send statements
+ * A driver maintains one or more {@link Session}s with a remote
+ * Neo4j instance. Through the {@link Session}s you can send statements
  * and retrieve results from the database.
  *
  * Drivers are reasonably expensive to create - you should strive to keep one
@@ -103,7 +103,7 @@ class Driver {
    * will be pulling a session out of the common pool.
    *
    * This comes with some responsibility - make sure you always call
-   * {@link Session#close()} when you are done using a session, and likewise,
+   * {@link close} when you are done using a session, and likewise,
    * make sure you don't close your session before you are done using it. Once
    * it is returned to the pool, the session will be reset to a clean state and
    * made available for others to use.

src/v1/error.js

@@ -20,8 +20,17 @@
 // A common place for constructing error objects, to keep them
 // uniform across the driver surface.
 
+/**
+ * @type {string}
+ */
 const SERVICE_UNAVAILABLE = 'ServiceUnavailable';
+/**
+ * @type {string}
+ */
 const SESSION_EXPIRED = 'SessionExpired';
+/**
+ * @type {string}
+ */
 const PROTOCOL_ERROR = 'ProtocolError';
 
 function newError(message, code="N/A") {

src/v1/graph-types.js

@@ -24,7 +24,7 @@ class Node {
   /**
    * @constructor
    * @param {Integer} identity - Unique identity
-   * @param {Array} labels - Array for all labels
+   * @param {Array<string>} labels - Array for all labels
    * @param {Object} properties - Map with node properties
    */
   constructor(identity, labels, properties) {
@@ -161,7 +161,7 @@ class Path {
    * @constructor
    * @param {Node} start  - start node
    * @param {Node} end - end node
-   * @param {Array} segments - Array of Segments
+   * @param {Array<PathSegment>} segments - Array of Segments
    */
   constructor(start, end, segments) {
     this.start = start;

src/v1/record.js

@@ -17,7 +17,7 @@
  * limitations under the License.
  */
 
-import {newError} from "./error";
+import {newError} from './error';
 
 function generateFieldLookup( keys ) {
   let lookup = {};
@@ -68,7 +68,7 @@ class Record {
    * will get three arguments - the value, the key and this record, in that
    * order.
    *
-   * @param visitor
+   * @param {function(value: Object, key: string, record: Record)} visitor the function to apply to each field.
    */
   forEach( visitor ) {
     for(let i=0;i<this.keys.length;i++) {

src/v1/result-summary.js

@@ -107,7 +107,7 @@ class ProfiledPlan {
 }
 
 /**
-  * Get statistical information for a {Result}.
+  * Get statistical information for a {@link Result}.
   * @access public
   */
 class StatementStatistics {

src/v1/routing-driver.js

@@ -24,6 +24,7 @@ import {LoadBalancer} from './internal/connection-providers';
 
 /**
  * A driver that supports routing in a core-edge cluster.
+ * @private
  */
 class RoutingDriver extends Driver {
 

src/v1/session.js

@@ -90,7 +90,7 @@ class Session {
    * While a transaction is open the session cannot be used to run statements outside the transaction.
    *
    * @param {string} bookmark - a reference to a previous transaction. DEPRECATED: This parameter is deprecated in
-   * favour of {@link Driver#session(string)} that accepts an initial bookmark. Session will ensure that all nested
+   * favour of {@link Driver#session} that accepts an initial bookmark. Session will ensure that all nested
    * transactions are chained with bookmarks to guarantee causal consistency.
    * @returns {Transaction} - New Transaction
    */
@@ -123,14 +123,14 @@ class Session {
   /**
    * Return the bookmark received following the last completed {@link Transaction}.
    *
-   * @return a reference to a previous transac'tion
+   * @return a reference to a previous transaction
    */
   lastBookmark() {
     return this._lastBookmark;
   }
 
   /**
-   * Execute given unit of work in a {@link Driver#READ} transaction.
+   * Execute given unit of work in a {@link READ} transaction.
    *
    * Transaction will automatically be committed unless the given function throws or returns a rejected promise.
    * Some failures of the given function or the commit itself will be retried with exponential backoff with initial
@@ -147,7 +147,7 @@ class Session {
   }
 
   /**
-   * Execute given unit of work in a {@link Driver#WRITE} transaction.
+   * Execute given unit of work in a {@link WRITE} transaction.
    *
    * Transaction will automatically be committed unless the given function throws or returns a rejected promise.
    * Some failures of the given function or the commit itself will be retried with exponential backoff with initial

src/v1/transaction.js

@@ -57,7 +57,7 @@ class Transaction {
 
   /**
    * Run Cypher statement
-   * Could be called with a statement object i.e.: {statement: "MATCH ...", parameters: {param: 1}}
+   * Could be called with a statement object i.e.: <code>{statement: "MATCH ...", parameters: {param: 1}}</code>
    * or with the statement and parameters as separate arguments.
    * @param {mixed} statement - Cypher statement to execute
    * @param {Object} parameters - Map with parameters to use in statement
@@ -179,7 +179,7 @@ let _states = {
         conn.sync();
       }).catch(error => observer.onError(error));
 
-      return newRunResult(observer, statement, parameters, () => observer.serverMeta());
+      return _newRunResult(observer, statement, parameters, () => observer.serverMeta());
     }
   },
 
@@ -192,19 +192,19 @@ let _states = {
         "transaction has failed and the transaction has been rolled back. Please start a new" +
         " transaction to run another statement."
       });
-      return {result: newDummyResult(observer, "COMMIT", {}), state: _states.FAILED};
+      return {result: _newDummyResult(observer, "COMMIT", {}), state: _states.FAILED};
     },
     rollback: (connectionHolder, observer) => {
       observer.onError({error:
       "Cannot rollback transaction, because previous statements in the " +
       "transaction has failed and the transaction has already been rolled back."});
-      return {result: newDummyResult(observer, "ROLLBACK", {}), state: _states.FAILED};
+      return {result: _newDummyResult(observer, "ROLLBACK", {}), state: _states.FAILED};
     },
     run: (connectionHolder, observer, statement, parameters) => {
       observer.onError({error:
       "Cannot run statement, because previous statements in the " +
       "transaction has failed and the transaction has already been rolled back."});
-      return newDummyResult(observer, statement, parameters);
+      return _newDummyResult(observer, statement, parameters);
     }
   },
 
@@ -215,17 +215,17 @@ let _states = {
         error: "Cannot commit statements in this transaction, because commit has already been successfully called on the transaction and transaction has been closed. Please start a new" +
         " transaction to run another statement."
       });
-      return {result: newDummyResult(observer, "COMMIT", {}), state: _states.SUCCEEDED};
+      return {result: _newDummyResult(observer, "COMMIT", {}), state: _states.SUCCEEDED};
     },
     rollback: (connectionHolder, observer) => {
       observer.onError({error:
         "Cannot rollback transaction, because transaction has already been successfully closed."});
-      return {result: newDummyResult(observer, "ROLLBACK", {}), state: _states.SUCCEEDED};
+      return {result: _newDummyResult(observer, "ROLLBACK", {}), state: _states.SUCCEEDED};
     },
     run: (connectionHolder, observer, statement, parameters) => {
       observer.onError({error:
       "Cannot run statement, because transaction has already been successfully closed."});
-      return newDummyResult(observer, statement, parameters);
+      return _newDummyResult(observer, statement, parameters);
     }
   },
 
@@ -235,17 +235,17 @@ let _states = {
       observer.onError({
         error: "Cannot commit this transaction, because it has already been rolled back."
       });
-      return {result: newDummyResult(observer, "COMMIT", {}), state: _states.ROLLED_BACK};
+      return {result: _newDummyResult(observer, "COMMIT", {}), state: _states.ROLLED_BACK};
     },
     rollback: (connectionHolder, observer) => {
       observer.onError({error:
         "Cannot rollback transaction, because transaction has already been rolled back."});
-      return {result: newDummyResult(observer, "ROLLBACK", {}), state: _states.ROLLED_BACK};
+      return {result: _newDummyResult(observer, "ROLLBACK", {}), state: _states.ROLLED_BACK};
     },
     run: (connectionHolder, observer, statement, parameters) => {
       observer.onError({error:
         "Cannot run statement, because transaction has already been rolled back."});
-      return newDummyResult(observer, statement, parameters);
+      return _newDummyResult(observer, statement, parameters);
     }
   }
 };
@@ -274,8 +274,9 @@ function _runPullAll(msg, connectionHolder, observer) {
  * @param {object} parameters - the parameters for cypher statement that produced the result.
  * @param {function} metadataSupplier - the function that returns a metadata object.
  * @return {Result} new result.
+ * @private
  */
-function newRunResult(observer, statement, parameters, metadataSupplier) {
+function _newRunResult(observer, statement, parameters, metadataSupplier) {
   return new Result(observer, statement, parameters, metadataSupplier, EMPTY_CONNECTION_HOLDER);
 }
 
@@ -287,8 +288,9 @@ function newRunResult(observer, statement, parameters, metadataSupplier) {
  * @param {string} statement - the cypher statement that produced the result.
  * @param {object} parameters - the parameters for cypher statement that produced the result.
  * @return {Result} new result.
+ * @private
  */
-function newDummyResult(observer, statement, parameters) {
+function _newDummyResult(observer, statement, parameters) {
   return new Result(observer, statement, parameters, emptyMetadataSupplier, EMPTY_CONNECTION_HOLDER);
 }