@technobuddha/library/dist/almost-equals.d.ts

A large library of useful functions

/**
 * Options for the {@link almostEquals} function
 *
 * @group Math
 * @category Comparison
 */
export type AlmostEqualsOptions = {
    /** Tolerance range. If specified, should be greater than 0. **/
    tolerance?: number;
};
/**
 * Tests whether the two values are equal to each other, within a certain
 * tolerance, taking into account floating point errors (numbers within EPSILON).
 *
 * @param a - First number to compare.
 * @param b - Second number to compare.
 * @param __namedParameters - see {@link AlmostEqualsOptions}
 * @defaultValue tolerance 0
 * @returns true if *a* and *b* are nearly equal.
 * @group Math
 * @category Comparison
 */
export declare function almostEquals(a: number, b: number, { tolerance }?: AlmostEqualsOptions): boolean;