@ndn/util
Version:
NDNts: general utilities
31 lines (30 loc) • 1.03 kB
TypeScript
/**
* Ensure n is an integer within `[0,MAX_SAFE_INTEGER]` range.
* @param n - Input number.
* @param typeName - Description of the number type.
*
* @throws RangeError
* Thrown if n is out of valid range.
*/
export declare function constrain(n: number, typeName: string): number;
/**
* Ensure n is an integer within `[0,max]` range.
* @param n - Input number.
* @param typeName - Description of the number type.
* @param max - Maximum allowed value (inclusive).
*
* @throws RangeError
* Thrown if n is out of valid range.
*/
export declare function constrain(n: number, typeName: string, max: number): number;
/**
* Ensure n is an integer within `[min,max]` range.
* @param n - Input number.
* @param typeName - Description of the number type.
* @param min - Minimum allowed value (inclusive).
* @param max - Maximum allowed value (inclusive).
*
* @throws RangeError
* Thrown if n is out of valid range.
*/
export declare function constrain(n: number, typeName: string, min: number, max: number): number;