Function: table_getGlobalFilterFn()#

function table_getGlobalFilterFn<TFeatures, TData>(table): 
  | FilterFn<TFeatures, TData>
  | undefined;

function table_getGlobalFilterFn<TFeatures, TData>(table): 
  | FilterFn<TFeatures, TData>
  | undefined;

Defined in: features/global-filtering/globalFilteringFeature.utils.ts:61

Resolves the filter function used for global filtering.

Function-valued options.globalFilterFn is returned directly, 'auto' delegates to table_getGlobalAutoFilterFn, and string values are looked up in the table's filter function registry.

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

Parameters#

table#

Table_Internal<TFeatures, TData>

Returns#

| FilterFn<TFeatures, TData> | undefined

Example#

const filterFn = table_getGlobalFilterFn(table)

const filterFn = table_getGlobalFilterFn(table)