Sys.Math
Sys.Math aggregates lists of numbers and rounds numbers to a given number of decimal digits. The …Map variants first take one number from each item of a list of objects, either by property name or with a function.
Availability: Everywhere
Functions
Section titled “Functions”sum(items: number[]): numberReturns the sum of the numbers. An empty list gives 0.
| Parameter | Type | Description |
|---|---|---|
items | number[] | Numbers to add up. |
Returns: number · Availability: Everywhere
sumMap()
Section titled “sumMap()”sumMap<T extends object>(items: T[], propertyOrFn: NumberPropertyKeys<T> | ((item: T) => number)): numberReturns the sum of one number taken from each item.
| Parameter | Type | Description |
|---|---|---|
items | T[] | Objects to aggregate. |
propertyOrFn | NumberPropertyKeys<T> | ((item: T) => number) | Name of the property to read from each item, or a function that returns the number for an item. |
const total = Sys.Math.sumMap(order.positions, 'amount')const totalWithTax = Sys.Math.sumMap(order.positions, (p) => p.amount * (1 + p.taxRate))Returns: number · Availability: Everywhere
Note
The type check accepts any property name of T, not only properties of type number. A non-numeric property gives a meaningless result.
avg(items: number[]): numberReturns the arithmetic mean of the numbers. An empty list gives NaN.
| Parameter | Type | Description |
|---|---|---|
items | number[] | Numbers to average. |
Returns: number · Availability: Everywhere
avgMap()
Section titled “avgMap()”avgMap<T extends object>(items: T[], propertyOrFn: NumberPropertyKeys<T> | ((item: T) => number)): numberReturns the arithmetic mean of one number taken from each item. An empty list gives NaN.
| Parameter | Type | Description |
|---|---|---|
items | T[] | Objects to aggregate. |
propertyOrFn | NumberPropertyKeys<T> | ((item: T) => number) | Name of the property to read from each item, or a function that returns the number for an item. |
Returns: number · Availability: Everywhere
min(items: number[]): numberReturns the smallest of the numbers. An empty list gives Infinity.
| Parameter | Type | Description |
|---|---|---|
items | number[] | Numbers to compare. |
Returns: number · Availability: Everywhere
minMap()
Section titled “minMap()”minMap<T extends object>(items: T[], propertyOrFn: NumberPropertyKeys<T> | ((item: T) => number)): numberReturns the smallest of one number taken from each item. An empty list gives Infinity.
| Parameter | Type | Description |
|---|---|---|
items | T[] | Objects to aggregate. |
propertyOrFn | NumberPropertyKeys<T> | ((item: T) => number) | Name of the property to read from each item, or a function that returns the number for an item. |
Returns: number · Availability: Everywhere
max(items: number[]): numberReturns the largest of the numbers. An empty list gives -Infinity.
| Parameter | Type | Description |
|---|---|---|
items | number[] | Numbers to compare. |
Returns: number · Availability: Everywhere
maxMap()
Section titled “maxMap()”maxMap<T extends object>(items: T[], propertyOrFn: NumberPropertyKeys<T> | ((item: T) => number)): numberReturns the largest of one number taken from each item. An empty list gives -Infinity.
| Parameter | Type | Description |
|---|---|---|
items | T[] | Objects to aggregate. |
propertyOrFn | NumberPropertyKeys<T> | ((item: T) => number) | Name of the property to read from each item, or a function that returns the number for an item. |
Returns: number · Availability: Everywhere
roundToDigits()
Section titled “roundToDigits()”roundToDigits(value: number, digits: number): numberRounds a number to the given number of decimal digits, with halves rounded up (towards positive infinity), as Math.round does.
| Parameter | Type | Description |
|---|---|---|
value | number | Number to round. |
digits | number | Number of decimal digits to keep. A negative value rounds to tens, hundreds, and so on. |
Returns: number · Availability: Everywhere
roundUpToDigits()
Section titled “roundUpToDigits()”roundUpToDigits(value: number, digits: number): numberRounds a number up (towards positive infinity) to the given number of decimal digits.
| Parameter | Type | Description |
|---|---|---|
value | number | Number to round. |
digits | number | Number of decimal digits to keep. |
Returns: number · Availability: Everywhere
roundDownToDigits()
Section titled “roundDownToDigits()”roundDownToDigits(value: number, digits: number): numberRounds a number down (towards negative infinity) to the given number of decimal digits.
| Parameter | Type | Description |
|---|---|---|
value | number | Number to round. |
digits | number | Number of decimal digits to keep. |
Returns: number · Availability: Everywhere