Added doc with jsdoc

Author: pirhoo

API.md

@@ -0,0 +1,114 @@
+## Classes
+
+<dl>
+<dt><a href="#Rest">Rest</a></dt>
+<dd><p>Class to communicate with CARTO Rest API</p>
+</dd>
+<dt><a href="#Turbocarto">Turbocarto</a></dt>
+<dd><p>Class to manipulate TurboCarto strings.</p>
+</dd>
+</dl>
+
+<a name="Rest"></a>
+
+## Rest
+Class to communicate with CARTO Rest API
+
+**Kind**: global class  
+
+* [Rest](#Rest)
+    * [new Rest(args)](#new_Rest_new)
+    * [.get(args)](#Rest+get) ⇒ <code>Promise</code>
+    * [.post(args)](#Rest+post) ⇒ <code>Promise</code>
+    * [.delete(args)](#Rest+delete) ⇒ <code>Promise</code>
+    * ~~[.del(args)](#Rest+del) ⇒ <code>Promise</code>~~
+
+<a name="new_Rest_new"></a>
+
+### new Rest(args)
+Create a Rest instance
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| args | <code>Object</code> | An object to configure the client with a "user" and "api_key" properties. |
+
+<a name="Rest+get"></a>
+
+### rest.get(args) ⇒ <code>Promise</code>
+Perform a GET request over CARTO API.
+
+**Kind**: instance method of [<code>Rest</code>](#Rest)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| args | <code>Object</code> | Spread parameters to `axios` method |
+
+<a name="Rest+post"></a>
+
+### rest.post(args) ⇒ <code>Promise</code>
+Perform a POST request over CARTO API.
+
+**Kind**: instance method of [<code>Rest</code>](#Rest)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| args | <code>Object</code> | Spread parameters to `axios` method |
+
+<a name="Rest+delete"></a>
+
+### rest.delete(args) ⇒ <code>Promise</code>
+Perform a DELETE request over CARTO API.
+
+**Kind**: instance method of [<code>Rest</code>](#Rest)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| args | <code>Object</code> | Spread parameters to `axios` method |
+
+<a name="Rest+del"></a>
+
+### ~~rest.del(args) ⇒ <code>Promise</code>~~
+***Deprecated***
+
+Perform a DELETE request over CARTO API.
+
+**Kind**: instance method of [<code>Rest</code>](#Rest)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| args | <code>Object</code> | Spread parameters to `axios` method |
+
+<a name="Turbocarto"></a>
+
+## Turbocarto
+Class to manipulate TurboCarto strings.
+
+**Kind**: global class  
+
+* [Turbocarto](#Turbocarto)
+    * [new Turbocarto(rest)](#new_Turbocarto_new)
+    * [.turbocartoToCartocss(turbocarto, sql)](#Turbocarto+turbocartoToCartocss) ⇒ <code>Promise</code>
+
+<a name="new_Turbocarto_new"></a>
+
+### new Turbocarto(rest)
+Create a Turbocarto instance
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| rest | [<code>Rest</code>](#Rest) | An instance of Rest |
+
+<a name="Turbocarto+turbocartoToCartocss"></a>
+
+### turbocarto.turbocartoToCartocss(turbocarto, sql) ⇒ <code>Promise</code>
+Populate the TurboCarto strings with data from an SQL query in order to generate CartoCSS.
+
+**Kind**: instance method of [<code>Turbocarto</code>](#Turbocarto)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| turbocarto | <code>string</code> | TurboCarto string. |
+| sql | <code>string</code> | SQL query to read data. |
+

README.md

@@ -1,6 +1,6 @@
 #  [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]
 
-> A wrapper for CartoDB APIs using SQL and REST.
+> A wrapper for CARTO APIs using SQL and REST.
 
 
 ## Install
@@ -9,13 +9,10 @@
 $ npm install --save cartodb-layers
 ```
 
-
-
 ## License
 
 MIT © [Journalism++](http://jplusplus.org)
 
-
 [npm-image]: https://badge.fury.io/js/cartodb-layers.svg
 [npm-url]: https://npmjs.org/package/cartodb-layers
 [travis-image]: https://travis-ci.org/jplusplus/cartodb-layers.svg?branch=master

lib/rest.js

@@ -8,7 +8,12 @@ const axios = require('axios'),
   jsonQuery = require('json-query'),
  Memoizable = require('./memoizable');
 
+ /** Class to communicate with CARTO Rest API  */
 class Rest extends Memoizable {
+  /**
+   * Create a Rest instance
+   * @param {Object} args - An object to configure the client with a "user" and "api_key" properties.
+   */
   constructor ({ user = "cartodb", api_key }) {
     super()
     this.api_key = api_key;
@@ -28,16 +33,36 @@ class Rest extends Memoizable {
       }
     });
   }
+  /**
+   * Perform a GET request over CARTO API.
+   * @param {Object} args - Spread parameters to `axios` method
+   * @return {Promise}
+   */
   get () {
     return this.axios.get(...arguments).then(r => r.data)
   }
+  /**
+   * Perform a POST request over CARTO API.
+   * @param {Object} args - Spread parameters to `axios` method
+   * @return {Promise}
+   */
   post () {
     return this.axios.post(...arguments).then(r => r.data)
   }
+  /**
+   * Perform a DELETE request over CARTO API.
+   * @param {Object} args - Spread parameters to `axios` method
+   * @return {Promise}
+   */
   delete () {
     return this.axios.delete(...arguments)
   }
-  // Backward compatibility
+  /**
+   * Perform a DELETE request over CARTO API.
+   * @param {Object} args - Spread parameters to `axios` method
+   * @return {Promise}
+   * @deprecated 
+   */
   del () {
     return this.delete(...arguments)
   }

lib/turbocarto.js

@@ -3,11 +3,22 @@ const Q = require('q');
 const SqlApiDatasource = require('./sqlApiDatasource.js')
 const Memoizable = require('./memoizable.js');
 
+/** Class to manipulate TurboCarto strings. */
 class Turbocarto extends Memoizable {
+  /**
+   * Create a Turbocarto instance
+   * @param {Rest} rest - An instance of Rest
+   */
   constructor (rest) {
     super();
     this.rest = rest;
   }
+  /**
+   * Populate the TurboCarto strings with data from an SQL query in order to generate CartoCSS.
+   * @param {string} turbocarto - TurboCarto string.
+   * @param {string} sql - SQL query to read data.
+   * @return {Promise}
+   */
   turbocartoToCartocss(turbocarto, sql) {
     const q = Q.defer();
     preprocessor(turbocarto, new SqlApiDatasource(sql, this.rest), (err, cartocss) => {

package.json

@@ -27,6 +27,7 @@
   "dependencies": {
     "axios": "^0.19.0",
     "cartodb": "^0.5.1",
+    "jsdoc-to-markdown": "^5.0.3",
     "json-query": "^2.2.2",
     "lodash": "^4.17.15",
     "q": "^1.5.1",
@@ -46,6 +47,7 @@
   },
   "scripts": {
     "test": "npx jest",
-    "lint": "npx grunt jshint"
+    "lint": "npx grunt jshint",
+    "doc": "npx jsdoc2md lib/*.js > API.md"
   }
 }