@backtrace/sdk-core/lib/dataStructures/numbers.d.ts

Backtrace-JavaScript SDK core library

export type ConstrainedNumber = (value: number) => number;
/**
 * Constrains `value` to `min` and `max` values, wrapping not matching values around.
 * @param min minimum value to allow
 * @param max maximum value to allow
 * @returns function accepting `value`
 *
 * @example
 * const wrap = wrapped(10, 20);
 * console.log(wrap(15)); // 15
 * console.log(wrap(21)); // 10, wrapped around
 * console.log(wrap(8)); // 18, wrapped around
 */
export declare function wrapped(min: number, max: number): ConstrainedNumber;
/**
 * Constrains `value` to `min` and `max` values.
 * @param min minimum value to allow
 * @param max maximum value to allow
 * @returns function accepting `value`
 *
 * @example
 * const clamp = clamped(10, 20);
 * console.log(wrap(15)); // 15
 * console.log(wrap(21)); // 20
 * console.log(wrap(8)); // 10
 */
export declare function clamped(min: number, max: number): ConstrainedNumber;