add new filterFns

Author: KevinVandy

packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts

@@ -50,7 +50,7 @@ export interface FilterFn<
     row: Row<TFeatures, TData>,
     columnId: string,
     filterValue: any,
-    addMeta: (meta: FilterMeta) => void,
+    addMeta?: (meta: FilterMeta) => void,
   ): boolean
   autoRemove?: ColumnFilterAutoRemoveTestFn<TFeatures, TData>
   resolveFilterValue?: TransformFilterValueFn<TFeatures, TData>

packages/table-core/src/features/column-filtering/createFilteredRowModel.ts

@@ -59,8 +59,8 @@ function _createFilteredRowModel<
   const resolvedGlobalFilters: Array<ResolvedColumnFilter<TFeatures, TData>> =
     []
 
-  columnFilters?.forEach((d) => {
-    const column = table_getColumn(table, d.id)
+  columnFilters?.forEach((columnFilter) => {
+    const column = table_getColumn(table, columnFilter.id)
 
     if (!column) {
       return
@@ -78,9 +78,10 @@ function _createFilteredRowModel<
     }
 
     resolvedColumnFilters.push({
-      id: d.id,
+      id: columnFilter.id,
       filterFn,
-      resolvedValue: filterFn.resolveFilterValue?.(d.value) ?? d.value,
+      resolvedValue:
+        filterFn.resolveFilterValue?.(columnFilter.value) ?? columnFilter.value,
     })
   })
 
@@ -105,7 +106,7 @@ function _createFilteredRowModel<
     })
   }
 
-  // Flag the prefiltered row model with each filter state
+  // Flag the pre-filtered row model with each filter state
   for (const row of rowModel.flatRows as Array<
     Row<TFeatures, TData> & Partial<Row_ColumnFiltering<TFeatures, TData>>
   >) {
@@ -169,5 +170,5 @@ function _createFilteredRowModel<
   }
 
   // Filter final rows using all of the active filters
-  return filterRows(rowModel.rows as any, filterRowsImpl as any, table)
+  return filterRows(rowModel.rows, filterRowsImpl as any, table)
 }

packages/table-core/src/fns/aggregationFns.ts

@@ -4,6 +4,9 @@ import type { TableFeatures } from '../types/TableFeatures'
 import type { Row } from '../types/Row'
 import type { AggregationFn } from '../features/column-grouping/ColumnGrouping.types'
 
+/**
+ * Aggregation function for summing up the values of a column.
+ */
 export const aggregationFn_sum: AggregationFn<any, any> = <
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -20,6 +23,9 @@ export const aggregationFn_sum: AggregationFn<any, any> = <
   }, 0)
 }
 
+/**
+ * Aggregation function for finding the minimum value of a column.
+ */
 export const aggregationFn_min: AggregationFn<any, any> = <
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -44,6 +50,9 @@ export const aggregationFn_min: AggregationFn<any, any> = <
   return minValue
 }
 
+/**
+ * Aggregation function for finding the maximum value of a column.
+ */
 export const aggregationFn_max: AggregationFn<any, any> = <
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -67,6 +76,9 @@ export const aggregationFn_max: AggregationFn<any, any> = <
   return maxValue
 }
 
+/**
+ * Aggregation function for finding the extent (min and max) of a column.
+ */
 export const aggregationFn_extent: AggregationFn<any, any> = <
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -93,6 +105,9 @@ export const aggregationFn_extent: AggregationFn<any, any> = <
   return [minValue, maxValue]
 }
 
+/**
+ * Aggregation function for finding the mean (average) of a column.
+ */
 export const aggregationFn_mean: AggregationFn<any, any> = <
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -115,6 +130,9 @@ export const aggregationFn_mean: AggregationFn<any, any> = <
   return
 }
 
+/**
+ * Aggregation function for finding the median value of a column.
+ */
 export const aggregationFn_median: AggregationFn<any, any> = <
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -139,6 +157,9 @@ export const aggregationFn_median: AggregationFn<any, any> = <
   return values.length % 2 !== 0 ? nums[mid] : (nums[mid - 1]! + nums[mid]!) / 2
 }
 
+/**
+ * Aggregation function for finding the unique values of a column.
+ */
 export const aggregationFn_unique: AggregationFn<any, any> = <
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -149,6 +170,9 @@ export const aggregationFn_unique: AggregationFn<any, any> = <
   return Array.from(new Set(leafRows.map((d) => d.getValue(columnId))).values())
 }
 
+/**
+ * Aggregation function for finding the count of unique values of a column.
+ */
 export const aggregationFn_uniqueCount: AggregationFn<any, any> = <
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -159,6 +183,9 @@ export const aggregationFn_uniqueCount: AggregationFn<any, any> = <
   return new Set(leafRows.map((d) => d.getValue(columnId))).size
 }
 
+/**
+ * Aggregation function for counting the number of rows in a column.
+ */
 export const aggregationFn_count: AggregationFn<any, any> = <
   TFeatures extends TableFeatures,
   TData extends RowData,