lossless-json/lib/types/utils.d.ts

Parse JSON without risk of losing numeric information

import type { NumberSplit } from './types';
/**
 * Test whether a string contains an integer number
 */
export declare function isInteger(value: string): boolean;
/**
 * Test whether a string contains a number
 * http://stackoverflow.com/questions/13340717/json-numbers-regular-expression
 */
export declare function isNumber(value: string): boolean;
/**
 * Test whether a string can be safely represented with a number
 * without information loss.
 *
 * When approx is true, floating point numbers that lose a few digits but
 * are still approximately equal in value are considered safe too.
 * Integer numbers must still be exactly equal.
 */
export declare function isSafeNumber(value: string, config?: {
    approx: boolean;
}): boolean;
export declare enum UnsafeNumberReason {
    underflow = "underflow",
    overflow = "overflow",
    truncate_integer = "truncate_integer",
    truncate_float = "truncate_float"
}
/**
 * When the provided value is an unsafe number, describe what the reason is:
 * overflow, underflow, truncate_integer, or truncate_float.
 * Returns undefined when the value is safe.
 */
export declare function getUnsafeNumberReason(value: string): UnsafeNumberReason | undefined;
/**
 * Convert a string into a number when it is safe to do so.
 * Throws an error otherwise, explaining the reason.
 */
export declare function toSafeNumberOrThrow(value: string, config?: {
    approx: boolean;
}): number;
/**
 * Split a number into sign, digits, and exponent.
 * The value can be constructed again from a split number by inserting a dot
 * at the second character of the digits if there is more than one digit,
 * prepending it with the sign, and appending the exponent like `e${exponent}`
 */
export declare function splitNumber(value: string): NumberSplit;
/**
 * Compare two strings containing a numeric value
 * Returns 1 when a is larger than b, 0 when they are equal,
 * and -1 when a is smaller than b.
 */
export declare function compareNumber(a: string, b: string): 1 | 0 | -1;
/**
 * Count the significant digits of a number.
 *
 * For example:
 *   '2.34' returns 3
 *   '-77' returns 2
 *   '0.003400' returns 2
 *   '120.5e+30' returns 4
 **/
export declare function countSignificantDigits(value: string): number;
/**
 * Get the significant digits of a number.
 *
 * For example:
 *   '2.34' returns '234'
 *   '-77' returns '77'
 *   '0.003400' returns '34'
 *   '120.5e+30' returns '1205'
 **/
export declare function extractSignificantDigits(value: string): string;
//# sourceMappingURL=utils.d.ts.map