Merge pull request #63 from leibale/TS-types

Ts types

Author: leibale

.circleci/config.yml

@@ -45,7 +45,7 @@ jobs:
 
 
       # generate types
-      - run: ./node_modules/.bin/tsc
+      - run: npm run types
 
       # run tests!
       - run: sudo npm install -g istanbul codecov
@@ -73,7 +73,7 @@ jobs:
             git config user.name "ci-build"
       - run:
           name: Create docs with jsdoc
-          command: jsdoc ./src -r -d ./docs -R ./README.md
+          command: npm run docs
       - run:
           name: Deploy docs to gh-pages branch
           command: gh-pages --dist ./docs --branch master --dest ./docs --message "[skip ci] Updates"

docs/Edge.html

@@ -215,7 +215,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="edge.js.html">edge.js</a>, <a href="edge.js.html#line5">line 5</a>
+        <a href="edge.js.html">edge.js</a>, <a href="edge.js.html#line10">line 10</a>
     </li></ul></dd>
 
 
@@ -321,7 +321,7 @@ <h5>Parameters:</h5>
             <td class="type">
 
 
-<span class="param-type">int</span>
+<span class="param-type">number</span>
 
 
 
@@ -331,7 +331,7 @@ <h5>Parameters:</h5>
 
 
 
-            <td class="description last"></td>
+            <td class="description last">(integer)</td>
         </tr>
 
 
@@ -372,7 +372,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="edge.js.html">edge.js</a>, <a href="edge.js.html#line26">line 26</a>
+        <a href="edge.js.html">edge.js</a>, <a href="edge.js.html#line30">line 30</a>
     </li></ul></dd>
 
 
@@ -456,7 +456,7 @@ <h4 class="name" id="toString"><span class="type-signature"></span>toString<span
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="edge.js.html">edge.js</a>, <a href="edge.js.html#line33">line 33</a>
+        <a href="edge.js.html">edge.js</a>, <a href="edge.js.html#line37">line 37</a>
     </li></ul></dd>
 
 
@@ -512,13 +512,13 @@ <h5>Returns:</h5>
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Edge.html">Edge</a></li><li><a href="Graph.html">Graph</a></li><li><a href="Node.html">Node</a></li><li><a href="Path.html">Path</a></li><li><a href="Record.html">Record</a></li><li><a href="ResultSet.html">ResultSet</a></li><li><a href="Statistics.html">Statistics</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Label">Label</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Edge.html">Edge</a></li><li><a href="Graph.html">Graph</a></li><li><a href="Node.html">Node</a></li><li><a href="Path.html">Path</a></li><li><a href="Record.html">Record</a></li><li><a href="ResultSet.html">ResultSet</a></li><li><a href="Statistics.html">Statistics</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Label">Label</a></li><li><a href="global.html#ResultSetColumnTypes">ResultSetColumnTypes</a></li><li><a href="global.html#ResultSetValueTypes">ResultSetValueTypes</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Mon Jan 25 2021 06:48:03 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Wed Feb 17 2021 14:48:31 GMT-0500 (Eastern Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>