minimum

Get the lowest of the passed Dinero objects.

You can only compare objects that share the same currency. The function also normalizes objects to the same scale (the highest) before comparing them.

In TypeScript, this is enforced at compile time when using typed currencies.

Parameters

Name	Type	Description	Required
dineroObjects	Dinero<TAmount, TCurrency>[]	The Dinero objects to minimum.	Yes

Code examples

Get the lowest object from a set

import { dinero, minimum } from 'dinero.js';
import { USD } from 'dinero.js/currencies';

const d1 = dinero({ amount: 150, currency: USD });
const d2 = dinero({ amount: 50, currency: USD });

minimum([d1, d2]); // a Dinero object with amount 50

Get the lowest object from a set after normalization

import { dinero, minimum } from 'dinero.js';
import { USD } from 'dinero.js/currencies';

const d1 = dinero({ amount: 500, currency: USD });
const d2 = dinero({ amount: 1000, currency: USD, scale: 3 });

minimum([d1, d2]); // a Dinero object with amount 1000 and scale 3