Fix(exporter): fix #3403 rename exporterAllDataPromise to exporterAllDataFn

Author: PaulL1

misc/tutorial/405_exporting_all_data_complex.ngdoc

@@ -32,7 +32,7 @@ This shows combined external pagination and sorting.
             { name: 'gender', enableSorting: false },
             { name: 'company', enableSorting: false }
           ],
-          exporterAllDataPromise: function() {
+          exporterAllDataFn: function() {
             return getPage(1, $scope.gridOptions.totalItems, paginationOptions.sort)
             .then(function() {
               $scope.gridOptions.useExternalPagination = false;

src/features/exporter/js/exporter.js

@@ -464,20 +464,41 @@
 
           /**
            * @ngdoc function
-           * @name exporterAllDataPromise
+           * @name exporterAllDataFn
            * @propertyOf  ui.grid.exporter.api:GridOptions
            * @description This promise is needed when exporting all rows,
            * and the data need to be provided by server side. Default is null.
            * @returns {Promise} a promise to load all data from server
            * 
            * @example
            * <pre>
-           *   gridOptions.exporterAllDataPromise = function () {
+           *   gridOptions.exporterAllDataFn = function () {
            *     return $http.get('/data/100.json')
            *   }
            * </pre>
            */
-          gridOptions.exporterAllDataPromise = gridOptions.exporterAllDataPromise ? gridOptions.exporterAllDataPromise : null;
+          gridOptions.exporterAllDataFn = gridOptions.exporterAllDataFn ? gridOptions.exporterAllDataFn : null;
+
+          /**
+           * @ngdoc function
+           * @name exporterAllDataPromise
+           * @propertyOf  ui.grid.exporter.api:GridOptions
+           * @description DEPRECATED - exporterAllDataFn used to be 
+           * called this, but it wasn't a promise, it was a function that returned
+           * a promise.  Deprecated, but supported for backward compatibility, use
+           * exporterAllDataFn instead.
+           * @returns {Promise} a promise to load all data from server
+           * 
+           * @example
+           * <pre>
+           *   gridOptions.exporterAllDataFn = function () {
+           *     return $http.get('/data/100.json')
+           *   }
+           * </pre>
+           */
+          if ( gridOptions.exporterAllDataFn == null && gridOptions.exporterAllDataPromise ) {
+            gridOptions.exporterAllDataFn = gridOptions.exporterAllDataPromise;
+          }
         },
 
 
@@ -586,7 +607,7 @@
          * @ngdoc function
          * @name loadAllDataIfNeeded
          * @methodOf  ui.grid.exporter.service:uiGridExporterService
-         * @description When using server side pagination, use exportAllDataPromise to
+         * @description When using server side pagination, use exporterAllDataFn to
          * load all data before continuing processing.
          * When using client side pagination, return a resolved promise so processing
          * continues immediately
@@ -599,8 +620,8 @@
          * uiGridExporterConstants.SELECTED
          */
         loadAllDataIfNeeded: function (grid, rowTypes, colTypes) {
-          if ( rowTypes === uiGridExporterConstants.ALL && grid.rows.length !== grid.options.totalItems && grid.options.exporterAllDataPromise) {
-            return grid.options.exporterAllDataPromise()
+          if ( rowTypes === uiGridExporterConstants.ALL && grid.rows.length !== grid.options.totalItems && grid.options.exporterAllDataFn) {
+            return grid.options.exporterAllDataFn()
               .then(function() {
                 grid.modifyRows(grid.options.data);
               });

src/features/exporter/test/exporter.spec.js

@@ -84,12 +84,12 @@ describe('ui.grid.exporter uiGridExporterService', function () {
         exporterMenuCsv: true,
         exporterMenuPdf: true,
         exporterFieldCallback: jasmine.any(Function),
-        exporterAllDataPromise: null,
+        exporterAllDataFn: null,
         exporterSuppressColumns: []        
       });
     });
 
-    it('set all options to non-default', function() {
+    iit('set all options to non-default, including using deprecated exporterAllDataPromise', function() {
       var callback = function() {};
       options = {
         exporterSuppressMenu: true,
@@ -135,6 +135,7 @@ describe('ui.grid.exporter uiGridExporterService', function () {
         exporterMenuCsv: false,
         exporterMenuPdf: false,
         exporterFieldCallback: callback,
+        exporterAllDataFn: callback,
         exporterAllDataPromise: callback,
         exporterSuppressColumns: [ 'buttons' ]
       });