Directus / @directus/sdk / rest / aggregate
Function: aggregate()
aggregate<
Schema,Collection,Options>(collection,options):RestCommand<AggregationOutput<Schema,Collection,Options>,Schema>
Aggregate allow you to perform calculations on a set of values, returning a single result.
Type parameters
• Schema extends object
• Collection extends string | number | symbol
• Options extends AggregationOptions<Schema, Collection>
Parameters
• collection: Collection
The collection to aggregate
• options: Options
The aggregation options
Returns
RestCommand<AggregationOutput<Schema, Collection, Options>, Schema>
Aggregated data
Throws
Will throw if collection is empty