BasicFilterSphereInput
Defined in: filter/src/types.ts:4
Extended by
Type Parameters
• Data = unknown
Properties
fieldDeepLimit?
optionalfieldDeepLimit:number
Defined in: filter/src/types.ts:30
The maximum depth of searching for filter fields.
Default
1filterFnList?
optionalfilterFnList:FnSchema[]
Defined in: filter/src/types.ts:18
The list of filter functions schema.
If not provided, the presetFilter will be used.
getLocaleText()?
optionalgetLocaleText: (key) =>string
Defined in: filter/src/types.ts:53
Returns the translation for the key.
Parameters
key
string
Returns
string
mapFieldName()?
optionalmapFieldName: (field) =>string
Defined in: filter/src/types.ts:38
Map the filter field to the field name.
For example, if the field path is user.name, you can map it to Name.
If not provided, the default map will use the fieldSchema.description or the field path as the name.
Parameters
field
Returns
string
mapFilterName()?
optionalmapFilterName: (filterSchema,field) =>string
Defined in: filter/src/types.ts:46
Map the filter fn schema to the filter label.
For example, if the filter name is eq, you can map it to Equal.
If not provided, the default map will use the filter name as the label.
Parameters
filterSchema
field
Returns
string
schema
schema:
ZodType<Data>
Defined in: filter/src/types.ts:8
The schema of the data to be filtered.