fx
API ReferenceCoreFunctions

Function: evaluateNaturalExpression()

@aliraslan/fx


@aliraslan/fx / core / evaluateNaturalExpression

Function: evaluateNaturalExpression()

evaluateNaturalExpression(input, baseCurrency, rates): EvaluatedExpression

Defined in: src/core/tokenizer.ts:136

Parses a natural-language financial expression (currency symbols, codes, magnitude words/suffixes, and arithmetic) and evaluates it into a Dinero value in baseCurrency, converting any other currencies mentioned using rates (a Dinero-format rate map for baseCurrency, as produced by convertRatesToDineroFormat).

Parameters

input

string

baseCurrency

string

rates

Rates

Returns

EvaluatedExpression

On this page