docs: HttpTransport

Author: paveltiunov

docs-gen/template/publish.js

@@ -37,18 +37,23 @@ function generateParams(doclet) {
   return `**Parameters:**\n\n${params.join('\n')}\n`;
 }
 
-const generateFunctionDocletSection = (doclet) => {
+const generateFunctionDocletSection = (doclet, isConstructor) => {
   const title = doclet.name;
-  const header = `##${doclet.longname.indexOf('#') !== -1 ? '#' : ''} ${title}\n`;
-  const signature = `\`${doclet.meta.code.name || doclet.name}(${doclet.params && doclet.params.filter(p => p.name.indexOf('.') === -1).map(p => p.name).join(', ') || ''})\`\n`;
+  const header = `##${doclet.longname.indexOf('#') !== -1 || isConstructor ? '#' : ''} ${title}${isConstructor ? ' Constructor' : ''}\n`;
+  const args = doclet.params && doclet.params.filter(p => p.name.indexOf('.') === -1).map(p => p.optional ? `[${p.name}]` : p.name).join(', ') || '';
+  const signature = `\`${isConstructor ? 'new ' : ''}${doclet.meta.code.name || doclet.name}(${args})\`\n`;
   const params = doclet.params ? generateParams(doclet) : ``;
   const returns = doclet.returns ? `**Returns:** ${doclet.returns.map(p => `${p.type ? renderLinks(p) : ''}${p.description ? ` ${resolveInlineLinks(p.description)}` : ''}`)}` : ``;
-  return [header, signature, `${resolveInlineLinks(doclet.description)}\n`, params, returns, '\n'].join('\n');
+  return [header, signature, doclet.description && `${resolveInlineLinks(doclet.description)}\n`, params, returns, '\n'].filter(f => !!f).join('\n');
 };
 
 const generateClassSection = (doclet) => {
   const header = `## ${doclet.name}\n`;
-  return [header, (doclet.classdesc || doclet.description).trim(), '\n'].join('\n');
+  let classSection = [header, (doclet.classdesc || doclet.description).trim(), '\n'].join('\n');
+  if (doclet.params && doclet.params.length) {
+    classSection = classSection.concat(generateFunctionDocletSection(doclet, true));
+  }
+  return classSection;
 };
 
 const tagValue = (doclet, tagOriginalTitle) => {

packages/cubejs-client-core/src/HttpTransport.js

@@ -1,7 +1,20 @@
+/**
+ * @module @cubejs-client/core
+ */
+
 import fetch from 'cross-fetch';
 import 'url-search-params-polyfill';
 
+/**
+ * Default transport implementation.
+ */
 class HttpTransport {
+  /**
+   * @param options - mandatory options object
+   * @param options.authorization - [jwt auth token](security)
+   * @param options.apiUrl - path to `/cubejs-api/v1`
+   * @param [options.headers] - object of custom headers
+   */
   constructor({ authorization, apiUrl, headers = {} }) {
     this.authorization = authorization;
     this.apiUrl = apiUrl;

packages/cubejs-client-core/src/index.js

@@ -198,8 +198,8 @@ class CubejsApi {
    * new Chart(context, chartjsConfig(resultSet));
    * ```
    * @param query - [Query object](query-format)
-   * @param options
-   * @param callback
+   * @param [options]
+   * @param [callback]
    * @returns {Promise} for {@link ResultSet} if `callback` isn't passed
    */
   load(query, options, callback) {
@@ -214,8 +214,8 @@ class CubejsApi {
   /**
    * Get generated SQL string for given `query`.
    * @param query - [Query object](query-format)
-   * @param options
-   * @param callback
+   * @param [options]
+   * @param [callback]
    * @return {Promise} for {@link SqlQuery} if `callback` isn't passed
    */
   sql(query, options, callback) {
@@ -229,8 +229,8 @@ class CubejsApi {
 
   /**
    * Get meta description of cubes available for querying.
-   * @param options
-   * @param callback
+   * @param [options]
+   * @param [callback]
    * @return {Promise} for {@link Meta} if `callback` isn't passed
    */
   meta(options, callback) {
@@ -265,12 +265,13 @@ class CubejsApi {
  );
  ```
  * @name cubejs
- * @param apiToken - [API token](security) is used to authorize requests and determine SQL database you're accessing.
+ * @param [apiToken] - [API token](security) is used to authorize requests and determine SQL database you're accessing.
  * In the development mode, Cube.js Backend will print the API token to the console on on startup.
- * Can be an async function without arguments that returns API token. Optional.
- * @param options - options object.
+ * Can be an async function without arguments that returns API token.
+ * @param [options] - options object.
  * @param options.apiUrl - URL of your Cube.js Backend.
  * By default, in the development environment it is `http://localhost:4000/cubejs-api/v1`.
+ * @param options.transport - transport implementation to use. {@link HttpTransport} will be used by default.
  * @returns {CubejsApi}
  * @order -10
  */