Merge branch 'improve-docs'

Author: oskarhane

README.md

@@ -82,3 +82,19 @@ See files under `examples/` on how to use.
 
 This runs the test suite against a fresh download of Neo4j.  
 Or `npm test` if you already have a running version of a compatible Neo4j server.
+
+## A note on numbers and the Integer type
+For this driver to fully map to the Neo4j type system handling of 64-bits Integers is needed.  
+Javascript can saftely represent numbers between `-(2`<sup>`53`</sup>` - 1)` and `(2`<sup>`53`</sup>` - 1)`.  
+Therefore, an Integer type is introduced. 
+
+### Write integers
+Number written directly e.g. `session.run("CREATE (n:Node {age: {age}})", {age: 22})` will be of type `Float` in Neo4j.  
+To write the `age` as an integer the `neo4j.int` method should be used.  
+E.g. `session.run("CREATE (n:Node {age: {age}})", {age: neo4j.int(22)})`.
+
+### Read integers
+To get the value of a from Neo4j received integer, the safeast way would be to use the `.toString()` method on 
+an Integer object.  
+E.g. `console.log(result.age.toString())`.  
+To check if a variable is of the Integer type, the method `neo4j.isInt(variable)` can be used.

lib/graph-types.js

@@ -90,6 +90,7 @@ class Relationship {
 
 /**
  * Class for UnboundRelationship Type.
+ * @access private
  */ 
 class UnboundRelationship {
   /**

lib/internal/integer.js renamed to lib/integer.js

@@ -24,6 +24,7 @@
 /**
  * Constructs a 64 bit two's-complement integer, given its low and high 32 bit values as *signed* integers.
  *  See the from* functions below for more convenient ways of constructing Integers.
+ * @access public
  * @exports Integer
  * @class A Integer class for representing a 64 bit two's-complement integer value.
  * @param {number} low The low (signed) 32 bits of the long
@@ -585,6 +586,7 @@ Object.defineProperty(Integer.prototype, "__isInteger__", {
 
 /**
  * Tests if the specified object is a Integer.
+ * @access private
  * @param {*} obj Object
  * @returns {boolean}
  * @expose
@@ -605,6 +607,7 @@ var INT_CACHE = {};
 
 /**
  * Returns a Integer representing the given 32 bit integer value.
+ * @access private
  * @param {number} value The 32 bit integer in question
  * @returns {!Integer} The corresponding Integer value
  * @expose
@@ -625,6 +628,7 @@ Integer.fromInt = function(value) {
 
 /**
  * Returns a Integer representing the given value, provided that it is a finite number. Otherwise, zero is returned.
+ * @access private
  * @param {number} value The number in question
  * @returns {!Integer} The corresponding Integer value
  * @expose
@@ -644,6 +648,7 @@ Integer.fromNumber = function(value) {
 /**
  * Returns a Integer representing the 64 bit integer that comes by concatenating the given low and high bits. Each is
  *  assumed to use 32 bits.
+ * @access private
  * @param {number} lowBits The low 32 bits
  * @param {number} highBits The high 32 bits
  * @returns {!Integer} The corresponding Integer value
@@ -655,6 +660,7 @@ Integer.fromBits = function(lowBits, highBits) {
 
 /**
  * Returns a Integer representation of the given string, written using the specified radix.
+ * @access private
  * @param {string} str The textual representation of the Integer
  * @param {number=} radix The radix in which the text is written (2-36), defaults to 10
  * @returns {!Integer} The corresponding Integer value
@@ -696,6 +702,7 @@ Integer.fromString = function(str, radix) {
 
 /**
  * Converts the specified value to a Integer.
+ * @access private
  * @param {!Integer|number|string|!{low: number, high: number}} val Value
  * @returns {!Integer}
  * @expose
@@ -794,10 +801,24 @@ Integer.MAX_VALUE = Integer.fromBits(0xFFFFFFFF|0, 0x7FFFFFFF|0, false);
  */
 Integer.MIN_VALUE = Integer.fromBits(0, 0x80000000|0, false);
 
-
+/**
+ * Cast value to Integer type.
+ * @access public
+ * @param {Mixed} value - The value to use.
+ * @return {Integer} - An object of type Integer.
+ */
 let int = Integer.fromValue;
 
+/**
+ * Check if a variable is of Integer type.
+ * @access public
+ * @param {Mixed} value - The varaible to check.
+ * @return {Boolean} - Is it of the Integer type?
+ */
+let isInt = Integer.isInteger;
+
 export default {
     Integer,
-    int
+    int,
+    isInt
 }

lib/internal/buf.js

@@ -30,7 +30,7 @@ let _node = require("buffer");
   * stateful read/write methods.
   * readXXX and writeXXX-methods move the inner position of the buffer.
   * putXXX and getXXX-methods do not.
-  * @access public
+  * @access private
   */
 class BaseBuffer
 {
@@ -355,6 +355,7 @@ class BaseBuffer
 
 /**
  * Basic buffer implementation that should work in most any modern JS env.
+ * @access private
  */
 class HeapBuffer extends BaseBuffer {
   constructor (arg) {
@@ -403,6 +404,7 @@ class HeapBuffer extends BaseBuffer {
 
 /**
  * Represents a view of slice of another buffer.
+ * @access private
  */
 class SliceBuffer extends BaseBuffer {
   constructor( start, length, inner ) {
@@ -438,6 +440,7 @@ class SliceBuffer extends BaseBuffer {
 
 /**
  * Buffer that combines multiple buffers, exposing them as one single buffer.
+ * @access private
  */
 class CombinedBuffer extends BaseBuffer {
   constructor (buffers) {
@@ -478,6 +481,7 @@ class CombinedBuffer extends BaseBuffer {
 
 /**
  * Buffer used in a Node.js environment
+ * @access private
  */
 class NodeBuffer extends BaseBuffer {
   constructor(arg) {
@@ -540,6 +544,7 @@ try {
 /**
 * Allocate a new buffer using whatever mechanism is most sensible for the
 * current platform
+* @access private
 * @param {Integer} size
 * @return new buffer
 */

lib/internal/ch-node.js

@@ -25,7 +25,7 @@ let _CONNECTION_IDGEN = 0;
 /**
   * In a Node.js environment the 'net' module is used
   * as transport.
-  * @access public
+  * @access private
   */
 
 class NodeChannel {

lib/internal/ch-websocket.js

@@ -22,7 +22,7 @@ import {HeapBuffer} from "./buf";
 
 /**
  * Create a new WebSocketChannel to be used in web browsers.
- * @access public
+ * @access private
  */
 class WebSocketChannel {
 

lib/internal/chunking.js

@@ -26,6 +26,7 @@ let
 
 /**
  * Looks like a writable buffer, chunks output transparently into a channel below.
+ * @access private
  */
 class Chunker extends buf.BaseBuffer {
   constructor( channel, bufferSize ) {
@@ -129,6 +130,7 @@ class Chunker extends buf.BaseBuffer {
 /**
  * Combines chunks until a complete message is gathered up, and then forwards that
  * message to an 'onmessage' listener.
+ * @access private
  */
 class Dechunker {
   constructor() {

lib/internal/connector.js

@@ -146,7 +146,7 @@ let _mappers = {
  * to call 'sync' when messages need to be sent, and it routes response
  * messages back to the originators of the requests that created those
  * response messages.
- * @access public
+ * @access private
  */
 class Connection {
   /**
@@ -312,6 +312,7 @@ class Connection {
 
 /**
  * Crete new connection to the provided url.
+ * @access private
  * @param {string} url - 'neo4j'-prefixed URL to Neo4j Bolt endpoint
  * @return {Connection} - New connection
  */

lib/internal/packstream.js

@@ -20,7 +20,7 @@
 import {debug} from "./log";
 import {alloc} from "./buf";
 import utf8 from "./utf8";
-import {Integer, int} from "./integer";
+import {Integer, int} from "../integer";
 
 let MAX_CHUNK_SIZE = 16383,
 TINY_TEXT = 0x80,
@@ -49,7 +49,7 @@ STRUCT_16 = 0xDD;
 
 /**
   * A Structure have a signature and fields.
-  * @access public
+  * @access private
   */
 class Structure {
   /**
@@ -76,7 +76,7 @@ class Structure {
 
 /**
   * Class to pack
-  * @access public
+  * @access private
   */
 class Packer {
   constructor (channel) {
@@ -241,7 +241,7 @@ class Packer {
 
 /**
   * Class to unpack
-  * @access public
+  * @access private
   */
 class Unpacker {
   constructor () {

lib/stream-observer.js renamed to lib/internal/stream-observer.js

@@ -25,6 +25,7 @@
  * for the incoming stream is registered. Thus, we keep fields around
  * for tracking head/records/tail. These are only used if there is no
  * observer registered.
+ * @access private
  */
 class StreamObserver {
   /**