Usage
Signature:
interface BaseDataFilter<D>
Generic Parameters
Parameter Description D Type of Data
Typescript Import Format
//To use this interface, import as below.
import {BaseDataFilter} from "ojs/ojdataprovider";
For additional information visit:
The interface for Filter
Methods
-
filter(item: D, index?: number, array?: Array<D>): boolean;
-
Specifies a filter function which has the same signature as the the callback which is specified for the JS Array.filter(): https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter This function will be optionally used by the DataProvider to do local filtering. This function is required by the DataProvider so that it is possible for DataProvider implementations to at least do local filtering.
Parameters:
Name Type Argument Description itemany The current element being processed in the array. indexnumber <optional>
The index of the current element being processed in the array. arrayArray <optional>
The array filter was called upon. - Since:
- 8.0.0
Returns:
True if the element satisfies the filter.
- Type
- boolean