680 add typedocs to new interface

This commit is contained in:
Andrew Wood
2021-01-26 11:41:28 -05:00
parent 771183097c
commit b143ea7e61

View File

@@ -1,7 +1,19 @@
import {PaginationComponentOptions} from './pagination-component-options.model';
import {SortOptions} from '../../core/cache/models/sort-options.model';
/**
* The pagination event that contains updated pagination properties
* for a given view
*/
export interface PaginationChangeEvent {
/**
* The pagination component object that contains id, current page, max size, page size options, and page size
*/
pagination: PaginationComponentOptions;
/**
* The sort options object that contains which field to sort by and the sorting direction
*/
sort: SortOptions;
}