chore: add jsdocs for conversion

qlik-oss · Nov 24, 2020 · c0113d1 · c0113d1
1 parent a7cce00
commit c0113d1
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 29 deletions.
diff --git a/apis/conversion/src/export-format.js b/apis/conversion/src/export-format.js
diff --git a/apis/conversion/src/hypercube.js b/apis/conversion/src/hypercube.js
@@ -1,7 +1,7 @@
 /* eslint-disable no-prototype-builtins */
 /* eslint-disable guard-for-in */
 /* eslint-disable no-restricted-syntax */
-import createExportFormat from './export-format';
+import createExportFormat from './exportFormat';
 import utils from './utils';
 import arrayUtils from './array-util';
 import helpers from './helpers';

diff --git a/apis/nucleus/src/viz.js b/apis/nucleus/src/viz.js
@@ -99,6 +99,19 @@ export default function viz({ model, halo, initialError, onDestroy = async () =>
       takeSnapshot() {
         return cellRef.current.takeSnapshot();
       },
+      /**
+       * Converts the visualization to a different registred type
+       * @ignore
+       * @param {string} newType - Which registered type to convert to
+       * @param {boolean=} forceUpdate - Whether to run setProperties or not, defaults to true.
+       * @returns {Promise<object>} Promise object that resolves to the full property tree of the converted visualizatiom
+       * @example
+       * const viz = await embed(app).render({
+       *   element,
+       *   id: 'abc'
+       * });
+       * viz.convertTo('barChart');
+       */
       async convertTo({ newType, forceUpdate = true }) {
         const propertyTree = await conversion.convertTo({ halo, model, cellRef, newType });
         if (forceUpdate) {

diff --git a/apis/stardust/api-spec/spec.conf.js b/apis/stardust/api-spec/spec.conf.js
@@ -6,6 +6,7 @@ module.exports = {
     '../supernova/src/**/*.js',
     '../locale/src/translator.js',
     '../theme/src/**/*.js',
+    '../conversion/src/**/*.js',
   ],
   api: {
     stability: 'stable',