From da9a130356d1674775a4246b0e377e08e7bbf880 Mon Sep 17 00:00:00 2001
From: Dylan Kilgore <dkilgore@eightfold.ai>
Date: Fri, 9 Sep 2022 16:49:07 -0700
Subject: [PATCH] chore: table: adds a bit more type annotations

---
 src/components/Table/Table.types.tsx | 35 +++++++++++++++++++++-------
 1 file changed, 27 insertions(+), 8 deletions(-)

diff --git a/src/components/Table/Table.types.tsx b/src/components/Table/Table.types.tsx
index 492c927e7..926155644 100644
--- a/src/components/Table/Table.types.tsx
+++ b/src/components/Table/Table.types.tsx
@@ -176,6 +176,9 @@ export interface ColumnType<RecordType>
 
 export interface ColumnGroupType<RecordType>
     extends Omit<ColumnType<RecordType>, 'dataIndex'> {
+    /**
+     * The ColumnGroup children.
+     */
     children: ColumnsType<RecordType>;
 }
 
@@ -186,15 +189,15 @@ export type ColumnsType<RecordType = unknown> = (
 
 export interface SelectionItem {
     /**
-     * Unique key of this selection.
+     * Unique key of the selection item.
      */
     key: string;
     /**
-     * Callback executed when this selection is clicked.
+     * Callback executed when the selection item is clicked.
      */
     onSelect?: SelectionItemSelectFn;
     /**
-     * Display text of this selection.
+     * Display text of the selection item.
      */
     text: React.ReactNode;
 }
@@ -324,18 +327,34 @@ export interface TablePaginationConfig extends Omit<PaginationProps, 'total'> {
 export const EMPTY_LIST: any[] = [];
 
 export interface ChangeEventInfo<RecordType> {
+    /**
+     * The chnage event params of filters.
+     */
+    filters: Record<string, FilterValue | null>;
+    /**
+     * The filter state.
+     */
+    filterStates: FilterState<RecordType>[];
+    /**
+     * The change event params of pagination.
+     */
     pagination: {
         currentPage?: number;
         pageSize?: number;
         total: number;
     };
-    filters: Record<string, FilterValue | null>;
+    /**
+     * The reset pagination function.
+     */
+    resetPagination: Function;
+    /**
+     * The change event params of sorter.
+     */
     sorter: SorterResult<RecordType> | SorterResult<RecordType>[];
-
-    filterStates: FilterState<RecordType>[];
+    /**
+     * The sorter state.
+     */
     sorterStates: SortState<RecordType>[];
-
-    resetPagination: Function;
 }
 
 export interface TableProps<RecordType>