Skip to content

createSingleFilter

createSingleFilter(ruleInput): object

Defined in: core/src/filter/utils.ts:140

Parameters

ruleInput

SingleFilterInput = ...

Returns

object

args

args: unknown[] = []

Arguments for the filter function

id

id: FilterId

invert?

optional invert: boolean

meta?

optional meta: Record<string, unknown>

name?

optional name: string

Filter name

If not provided, it means user didn’t select a filter.

path?

optional path: FilterPath

Field path

If it’s a empty array, it means the root object. If not provided, it means user didn’t select a field.

type

type: "Filter" = "Filter"