averagex
averagex<T>(objects: T[], expression: (object: T) => number): number
Calculates the average (arithmetic mean) of a set of expressions evaluated over an array of objects.
Syntax
ts
import { averagex } from 'ts-dax'
const objects = [
{ name: 'Apple', price: 0.75 },
{ name: 'Banana', price: 0.45 },
{ name: 'Orange', price: 0.6 },
]
const averagePrice = averagex(objects, ({ price }) => price)
// => 0.6
Parameters
| Param | Type | Description |
|---|---|---|
objects | Date | The start date object. |
end | Date | The end date object. |
Return value
A Set<Date> of contiguous dates between start and end.
INFO
The range of dates in the return value are inclusive of start and end.
Exceptions
Error('start date cannot be greater than end date')
Thrown if the provided start date is greater than the provided end date.
Examples
The following expression generates a Set<Date> containing dates from January 1st, 2015 to December 31st, 2021 (inclusive of both dates).
ts
import { calendar } from 'ts-dax'
const dates = calendar(new Date('2015-01-01'), new Date('2021-12-31'))