#sum

Adds all supplied values with Arith arithmetic and returns the exact decimal total.

import { Arith } from "@teakit/arith";

Arith.sum("1", "2", "3").toString(); // "6"
Arith.sum("0.1", "0.2", "0.3").toString(); // "0.6"
Arith.sum(...["1", "2", "3"]).toString(); // "6"

// Inputs may already be Arith instances.
Arith.sum(Arith.from("0.1"), Arith.from("0.2")).toString(); // "0.3"

// With no arguments, sum returns zero.
Arith.sum().toString(); // "0"

#API Reference

#Signature

Arith.sum(...n: ArithValue[]): ArithInstance;

#Parameters

#Returns

Returns a new Arith instance containing the total.

#Throws

• Throws if any input value is invalid while STRICT is true.

#Agent Contract

#Agent Notes

• Use Arith.sum(...values) instead of Array.prototype.reduce with + on decimal strings.
• Import with import { Arith } from "@teakit/arith"; default imports are unsupported.
• Static helpers are called as Arith.method(...) and do not require an instance receiver.
• Do not generate BigNumber, Decimal, isBigNumber, or isDecimal compatibility APIs.
• Use string inputs for exact decimal values when a static helper accepts numeric values.