CURRENCY_AMOUNT()function

CURRENCY_AMOUNT(currency: CurrencyCode): CurrencyAmountSchema
ParamType
currencyCurrencyCode
ISO 4217 currency code that determines the step and symbol. required
Return
CurrencyAmountSchema
Schema representing a numeric amount in a specific currency.
Throws
unknown
string if currency is not a valid ISO 4217 currency code.

Create a CurrencyAmountSchema for a non-negative monetary amount in a currency.

Sugar factory for CurrencyAmountSchema.

Examples

CURRENCY_AMOUNT("GBP").validate("12.345") // 12.35