Forest Admin - API reference
Preparing search index...
@forestadmin/datasource-toolkit
ConditionTreeLeaf
Class ConditionTreeLeaf
Hierarchy (
View Summary
)
ConditionTree
ConditionTreeLeaf
Index
Constructors
constructor
Properties
field
operator
value?
Accessors
projection
use
Interval
Operator
Methods
apply
every
Leaf
for
Each
Leaf
inverse
match
nest
override
replace
Fields
replace
Leafs
replace
Leafs
Async
some
Leaf
to
Plain
Object
unnest
Constructors
constructor
new
ConditionTreeLeaf
(
field
:
string
,
operator
:
|
"Equal"
|
"NotEqual"
|
"LessThan"
|
"GreaterThan"
|
"LessThanOrEqual"
|
"GreaterThanOrEqual"
|
"Match"
|
"NotContains"
|
"NotIContains"
|
"LongerThan"
|
"ShorterThan"
|
"IncludesAll"
|
"IncludesNone"
|
"Today"
|
"Yesterday"
|
"PreviousMonth"
|
"PreviousQuarter"
|
"PreviousWeek"
|
"PreviousYear"
|
"PreviousMonthToDate"
|
"PreviousQuarterToDate"
|
"PreviousWeekToDate"
|
"PreviousXDaysToDate"
|
"PreviousXDays"
|
"PreviousYearToDate"
|
"Present"
|
"Blank"
|
"Missing"
|
"In"
|
"NotIn"
|
"StartsWith"
|
"EndsWith"
|
"Contains"
|
"IStartsWith"
|
"IEndsWith"
|
"IContains"
|
"Like"
|
"ILike"
|
"Before"
|
"After"
|
"AfterXHoursAgo"
|
"BeforeXHoursAgo"
|
"Future"
|
"Past"
,
value
?:
unknown
,
)
:
ConditionTreeLeaf
Parameters
field
:
string
operator
:
|
"Equal"
|
"NotEqual"
|
"LessThan"
|
"GreaterThan"
|
"LessThanOrEqual"
|
"GreaterThanOrEqual"
|
"Match"
|
"NotContains"
|
"NotIContains"
|
"LongerThan"
|
"ShorterThan"
|
"IncludesAll"
|
"IncludesNone"
|
"Today"
|
"Yesterday"
|
"PreviousMonth"
|
"PreviousQuarter"
|
"PreviousWeek"
|
"PreviousYear"
|
"PreviousMonthToDate"
|
"PreviousQuarterToDate"
|
"PreviousWeekToDate"
|
"PreviousXDaysToDate"
|
"PreviousXDays"
|
"PreviousYearToDate"
|
"Present"
|
"Blank"
|
"Missing"
|
"In"
|
"NotIn"
|
"StartsWith"
|
"EndsWith"
|
"Contains"
|
"IStartsWith"
|
"IEndsWith"
|
"IContains"
|
"Like"
|
"ILike"
|
"Before"
|
"After"
|
"AfterXHoursAgo"
|
"BeforeXHoursAgo"
|
"Future"
|
"Past"
Optional
value
:
unknown
Returns
ConditionTreeLeaf
Properties
field
field
:
string
operator
operator
:
|
"Equal"
|
"NotEqual"
|
"LessThan"
|
"GreaterThan"
|
"LessThanOrEqual"
|
"GreaterThanOrEqual"
|
"Match"
|
"NotContains"
|
"NotIContains"
|
"LongerThan"
|
"ShorterThan"
|
"IncludesAll"
|
"IncludesNone"
|
"Today"
|
"Yesterday"
|
"PreviousMonth"
|
"PreviousQuarter"
|
"PreviousWeek"
|
"PreviousYear"
|
"PreviousMonthToDate"
|
"PreviousQuarterToDate"
|
"PreviousWeekToDate"
|
"PreviousXDaysToDate"
|
"PreviousXDays"
|
"PreviousYearToDate"
|
"Present"
|
"Blank"
|
"Missing"
|
"In"
|
"NotIn"
|
"StartsWith"
|
"EndsWith"
|
"Contains"
|
"IStartsWith"
|
"IEndsWith"
|
"IContains"
|
"Like"
|
"ILike"
|
"Before"
|
"After"
|
"AfterXHoursAgo"
|
"BeforeXHoursAgo"
|
"Future"
|
"Past"
Optional
value
value
?:
unknown
Accessors
projection
get
projection
()
:
Projection
Returns
Projection
use
Interval
Operator
get
useIntervalOperator
()
:
boolean
Returns
boolean
Methods
apply
apply
(
records
:
RecordData
[]
,
collection
:
Collection
,
timezone
:
string
,
)
:
RecordData
[]
Parameters
records
:
RecordData
[]
collection
:
Collection
timezone
:
string
Returns
RecordData
[]
every
Leaf
everyLeaf
(
handler
:
LeafTester
)
:
boolean
Parameters
handler
:
LeafTester
Returns
boolean
for
Each
Leaf
forEachLeaf
(
handler
:
LeafCallback
)
:
void
Parameters
handler
:
LeafCallback
Returns
void
inverse
inverse
()
:
ConditionTree
Returns
ConditionTree
match
match
(
record
:
RecordData
,
collection
:
Collection
,
timezone
:
string
)
:
boolean
Parameters
record
:
RecordData
collection
:
Collection
timezone
:
string
Returns
boolean
nest
nest
(
prefix
:
string
)
:
ConditionTree
Parameters
prefix
:
string
Returns
ConditionTree
override
override
(
params
:
Partial
<
PlainConditionTreeLeaf
>
)
:
ConditionTreeLeaf
Parameters
params
:
Partial
<
PlainConditionTreeLeaf
>
Returns
ConditionTreeLeaf
replace
Fields
replaceFields
(
handler
:
(
field
:
string
)
=>
string
)
:
ConditionTree
Parameters
handler
:
(
field
:
string
)
=>
string
Returns
ConditionTree
replace
Leafs
replaceLeafs
(
handler
:
LeafReplacer
,
bind
?:
unknown
)
:
ConditionTree
Parameters
handler
:
LeafReplacer
Optional
bind
:
unknown
Returns
ConditionTree
replace
Leafs
Async
replaceLeafsAsync
(
handler
:
AsyncLeafReplacer
,
bind
?:
unknown
,
)
:
Promise
<
ConditionTree
>
Parameters
handler
:
AsyncLeafReplacer
Optional
bind
:
unknown
Returns
Promise
<
ConditionTree
>
some
Leaf
someLeaf
(
handler
:
LeafTester
)
:
boolean
Parameters
handler
:
LeafTester
Returns
boolean
to
Plain
Object
toPlainObject
()
:
PlainConditionTree
Returns
PlainConditionTree
unnest
unnest
()
:
ConditionTreeLeaf
Returns
ConditionTreeLeaf
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
field
operator
value
Accessors
projection
use
Interval
Operator
Methods
apply
every
Leaf
for
Each
Leaf
inverse
match
nest
override
replace
Fields
replace
Leafs
replace
Leafs
Async
some
Leaf
to
Plain
Object
unnest
Forest Admin - API reference
Loading...