Forest Admin - API reference
Preparing search index...
@forestadmin/datasource-toolkit
CollectionUtils
Class CollectionUtils
Index
Constructors
constructor
Methods
aggregate
Relation
get
Field
Schema
get
Inverse
Relation
get
Through
Origin
get
Through
Target
get
Value
list
Relation
Constructors
constructor
new
CollectionUtils
()
:
CollectionUtils
Returns
CollectionUtils
Methods
Static
aggregate
Relation
aggregateRelation
(
collection
:
Collection
,
id
:
CompositeId
,
relationName
:
string
,
caller
:
Caller
,
foreignFilter
:
Filter
,
aggregation
:
Aggregation
,
limit
?:
number
,
)
:
Promise
<
AggregateResult
[]
>
Parameters
collection
:
Collection
id
:
CompositeId
relationName
:
string
caller
:
Caller
foreignFilter
:
Filter
aggregation
:
Aggregation
Optional
limit
:
number
Returns
Promise
<
AggregateResult
[]
>
Static
get
Field
Schema
getFieldSchema
(
collection
:
Collection
,
path
:
string
)
:
FieldSchema
Parameters
collection
:
Collection
path
:
string
Returns
FieldSchema
Static
get
Inverse
Relation
getInverseRelation
(
collection
:
Collection
,
relationName
:
string
)
:
string
Parameters
collection
:
Collection
relationName
:
string
Returns
string
Static
get
Through
Origin
getThroughOrigin
(
collection
:
Collection
,
relationName
:
string
)
:
string
Parameters
collection
:
Collection
relationName
:
string
Returns
string
Static
get
Through
Target
getThroughTarget
(
collection
:
Collection
,
relationName
:
string
)
:
string
Parameters
collection
:
Collection
relationName
:
string
Returns
string
Static
get
Value
getValue
(
collection
:
Collection
,
caller
:
Caller
,
id
:
CompositeId
,
field
:
string
,
)
:
Promise
<
unknown
>
Parameters
collection
:
Collection
caller
:
Caller
id
:
CompositeId
field
:
string
Returns
Promise
<
unknown
>
Static
list
Relation
listRelation
(
collection
:
Collection
,
id
:
CompositeId
,
relationName
:
string
,
caller
:
Caller
,
foreignFilter
:
PaginatedFilter
,
projection
:
Projection
,
)
:
Promise
<
RecordData
[]
>
Parameters
collection
:
Collection
id
:
CompositeId
relationName
:
string
caller
:
Caller
foreignFilter
:
PaginatedFilter
projection
:
Projection
Returns
Promise
<
RecordData
[]
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
aggregate
Relation
get
Field
Schema
get
Inverse
Relation
get
Through
Origin
get
Through
Target
get
Value
list
Relation
Forest Admin - API reference
Loading...