@lion/localize
Version:
The localization system helps to manage localization data split into locales and automate its loading
21 lines (20 loc) • 891 B
TypeScript
/**
* Parses a number string and returns the best possible javascript number.
* For edge cases it may use locale to give the best possible assumption.
*
* It has 3 "methods" of returning numbers
* - 'unparseable': becomes just numbers
* - 'withLocale': result depends on given or global locale
* - 'heuristic': result depends on considering separators
*
* @example
* parseNumber('1.234.567'); // method: unparseable => 1234567
* parseNumber('1.234'); // method: withLocale => depending on locale 1234 or 1.234
* parseNumber('1.234,56'); // method: heuristic => 1234.56
* parseNumber('1 234.56'); // method: heuristic => 1234.56
* parseNumber('1,234.56'); // method: heuristic => 1234.56
*
* @param {string} value Number to be parsed
* @param {object} [options] Locale Options
*/
export function parseNumber(value: string, options?: object | undefined): number | undefined;