docS

Author: xsalonx

lib/public/models/DataExportModel.js

@@ -21,59 +21,76 @@ import pick from '../utilities/pick.js';
 export class DataExportModel extends Observable {
     /**
      * Constructor
-     * @param {ObservableData<RemoteData<object[]>>} items$ observable data used as source for export
-     * @param {function} onNoDataAction
+     * @param {ObservableData<RemoteData<T[]>>} items$ observable data used as source for export
+     * @param {function} onDataNotAskedAction
      */
-    constructor(items$, onNoDataAction) {
+    constructor(items$, onDataNotAskedAction) {
         super();
 
-        /** @type {ObservableData<RemoteData<object[]>>} */
         this._items$ = items$;
         this._items$.bubbleTo(this);
 
-        /** @type {string[]} */
         this._selectedFields = [];
 
-        /** @type {string} */
         this._selectedExportType = 'JSON';
 
-        /** @type {Observable} */
         this._visualChange$ = new Observable();
 
         this._exportName = 'data';
 
         this.columnFormats = null;
-        this._onNoDataAction = onNoDataAction;
+        this._onDataNotAskedAction = onDataNotAskedAction;
 
         this._disabled = null;
 
         this._totalExistingItemsCount = null;
     }
 
+    /**
+     * Get total number of items that model knows they exist
+     * @return {number} totalExistingItemsCount
+     */
     get totalExistingItemsCount() {
         return this._totalExistingItemsCount;
     }
 
+    /**
+     * Set total number of items that model should they exist
+     * @param {number} totalExistingItemsCount count
+     */
     setTotalExistingItemsCount(totalExistingItemsCount) {
         this._totalExistingItemsCount = totalExistingItemsCount;
     }
 
+    /**
+     * State whether exporting is enabled
+     * @return {boolean} if true disabled, otherwise enabled
+     */
     get disabled() {
         return this._disabled;
     }
 
-    setDisabled(value) {
-        this._disabled = value;
+    /**
+     * Set whether exporting is enabled
+     * @param {boolean} disabled if true disabled, otherwise enabled
+     */
+    setDisabled(disabled) {
+        this._disabled = disabled;
     }
 
     /**
-     * 
+     * If the model has no data to be exported, it calls for it via action function provided in constructor
+     * @return {Promise<void>|null} promise if data were not asked for, null otherwise
      */
-    askForData() {
-        this.items.match({
-            NotAsked: () => this._onNoDataAction(),
-            Other: () => null,
-        });
+    callForData() {
+        if (this._onDataNotAskedAction) {
+            return this.items.match({
+                NotAsked: () => this._onDataNotAskedAction(),
+                Other: () => null,
+            });
+        } else {
+            throw new Error('onDataNotAskedAction was not provided');
+        }
     }
 
     /**

lib/public/views/Runs/Overview/exportTriggerAndModal.js

@@ -110,7 +110,7 @@ const errorDisplay = () => h('.danger', 'Data fetching failed');
  * @return {Component} Return the view of the inputs
  */
 const exportModal = (exportModel, modalHandler) => {
-    exportModel.askForData();
+    exportModel.callForData();
     return h('div#export-runs-modal', [
         h('h2', 'Export data'),
         exportModel.items.match({