time-to-botec/squiggle/node_modules/@stdlib/assert/is-range-error/README.md

isRangeError

Test if a value is a RangeError object.

Usage

var isRangeError = require( '@stdlib/assert/is-range-error' );

isRangeError( value )

Tests if a value is a RangeError object.

var bool = isRangeError( new RangeError( 'beep' ) );
// returns true

Notes

• This function should not be considered robust. While the function should always return true if provided a RangeError (or a descendant) object, false positives may occur due to the fact that the RangeError constructor inherits from Error and has no internal class of its own. Hence, RangeError impersonation is possible.

Examples

var isRangeError = require( '@stdlib/assert/is-range-error' );

var bool = isRangeError( new RangeError( 'range error' ) );
// returns true

bool = isRangeError( new Error( 'error' ) );
// returns false

bool = isRangeError( new EvalError( 'eval error' ) );
// returns false

bool = isRangeError( new ReferenceError( 'reference error' ) );
// returns false

bool = isRangeError( new SyntaxError( 'syntax error' ) );
// returns false

bool = isRangeError( new TypeError( 'type error' ) );
// returns false

bool = isRangeError( new URIError( 'URI error' ) );
// returns false

bool = isRangeError( {} );
// returns false

bool = isRangeError( null );
// returns false