fix(ngTableEventsChannel): event callbacks defines incorrect params

ccrowhurstram · ccrowhurstram · commit b7a2aa626667 · 2016-12-06T21:15:33.000Z
afterDataSorted and afterDataFiltered defined with wrong params.

The publisher parameter should be the `NgTableParams` instancefor whom the event relates and should the first parameter.

BREAKING CHANGE:

* changed signatures of `afterDataSorted` + `afterDataFiltered` events

Previously:

```ts
(publisher: IDefaultGetData&lt;T&gt;, params: NgTableParams&lt;T&gt;, newData: DataResult&lt;T&gt;[] ): any
```

Now:

```ts
(publisher: NgTableParams&lt;T&gt;, newData: DataResult&lt;T&gt;[] ): any
```
diff --git a/src/core/data/ngTableDefaultGetData.ts b/src/core/data/ngTableDefaultGetData.ts
@@ -66,7 +66,6 @@ export class NgTableDefaultGetDataProvider implements IServiceProvider {
         function ngTableDefaultGetData<T>($filter: IFilterService, ngTableEventsChannel: NgTableEventsChannel): IDefaultGetData<T> {
 
             const defaultDataOptions = { applyFilter: true, applySort: true, applyPaging: true };
-            const self = this;
 
             (getData as IDefaultGetData<T>).applyPaging = applyPaging;
             (getData as IDefaultGetData<T>).getFilterFn = getFilterFn;
@@ -122,10 +121,10 @@ export class NgTableDefaultGetDataProvider implements IServiceProvider {
                 const options = ng1.extend({}, defaultDataOptions, params.settings().dataOptions);
 
                 const fData = options.applyFilter ? applyFilter(data, params) : data;
-                ngTableEventsChannel.publishAfterDataFiltered(self, params, fData);
+                ngTableEventsChannel.publishAfterDataFiltered(params, fData);
 
                 const orderedData = options.applySort ? applySort(fData, params) : fData;
-                ngTableEventsChannel.publishAfterDataSorted(self, params,orderedData);
+                ngTableEventsChannel.publishAfterDataSorted(params,orderedData);
 
                 return options.applyPaging ? applyPaging(orderedData, params) : orderedData;
             }
diff --git a/src/core/ngTableEventsChannel.ts b/src/core/ngTableEventsChannel.ts
@@ -53,13 +53,13 @@ export interface IPagesChangedListener {
 * Signature of the event hander that is registered to receive the *afterDataFiltered* event
 */
 export interface IAfterDataFilteredListener<T> {
-    (publisher: IDefaultGetData<T>, params: NgTableParams<T>, newData: DataResult<T>[] ): any
+    (publisher: NgTableParams<T>, newData: DataResult<T>[] ): any
 }
 /**
 * Signature of the event hander that is registered to receive the *afterDataSorted* event
 */
 export interface IAfterDataSortedListener<T> {
-    (publisher: IDefaultGetData<T>, params: NgTableParams<T>, newData: DataResult<T>[] ): any
+    (publisher: NgTableParams<T>, newData: DataResult<T>[] ): any
 }
 
 /**
@@ -207,8 +207,8 @@ export interface NgTableEventsChannel {
     publishAfterReloadData<T>(publisher: NgTableParams<T>, newData: T[], oldData: T[]): void;
     publishDatasetChanged<T>(publisher: NgTableParams<T>, newDataset: T[], oldDataset: T[]): void;
     publishPagesChanged<T>(publisher: NgTableParams<T>, newPages: IPageButton[], oldPages: IPageButton[]): void;
-    publishAfterDataFiltered<T>(publisher: IDefaultGetData<T>, params: NgTableParams<T>, newData: T[]): void;
-    publishAfterDataSorted<T>(publisher: IDefaultGetData<T>, params: NgTableParams<T>, newData: T[]): void;
+    publishAfterDataFiltered<T>(publisher: NgTableParams<T>, newData: T[]): void;
+    publishAfterDataSorted<T>(params: NgTableParams<T>, newData: T[]): void;
 }
 
 export class NgTableEventsChannel {
diff --git a/test/tableParamsSpec.spec.ts b/test/tableParamsSpec.spec.ts
@@ -1651,7 +1651,7 @@ describe('NgTableParams', () => {
 
         describe('general pub/sub mechanics', () => {
 
-            const supportedEvents = ['DatasetChanged', 'AfterReloadData', 'PagesChanged', 'AfterCreated'];
+            const supportedEvents = ['DatasetChanged', 'AfterReloadData', 'PagesChanged', 'AfterCreated', 'AfterDataFiltered', 'AfterDataSorted'];
 
             it('should be safe to publish event when no subscribers', () => {
 
@@ -2160,7 +2160,7 @@ describe('NgTableParams', () => {
         describe('afterDataFiltered', () => {
             it('should fire when a reload completes - no filter', () => {
                 // given
-                ngTableEventsChannel.onAfterDataFiltered((getData, params, newVal) => {
+                ngTableEventsChannel.onAfterDataFiltered((params, newVal) => {
                     actualPublisher = params;
                     actualEventArgs = [newVal];
                 });
@@ -2178,7 +2178,7 @@ describe('NgTableParams', () => {
 
             it('should fire when a reload completes and the data is filtered', () => {
                 // given
-                ngTableEventsChannel.onAfterDataFiltered((getData, params, newVal) => {
+                ngTableEventsChannel.onAfterDataFiltered((params, newVal) => {
                     actualPublisher = params;
                     actualEventArgs = [newVal];
                 });
@@ -2201,7 +2201,7 @@ describe('NgTableParams', () => {
         describe('afterDataSorted', () => {
             it('should fire when a reload completes - no order', () => {
                 // given
-                ngTableEventsChannel.onAfterDataSorted((getData, params, newVal) => {
+                ngTableEventsChannel.onAfterDataSorted((params, newVal) => {
                     actualPublisher = params;
                     actualEventArgs = [newVal];
                 });
@@ -2219,7 +2219,7 @@ describe('NgTableParams', () => {
 
             it('should fire when a reload completes and the data is filtered', () => {
                 // given
-                ngTableEventsChannel.onAfterDataSorted((getData, params, newVal) => {
+                ngTableEventsChannel.onAfterDataSorted((params, newVal) => {
                     actualPublisher = params;
                     actualEventArgs = [newVal];
                 });
