time-to-botec/squiggle/node_modules/@stdlib/assert/is-circular-array

isCircularArray

Test if a value is an array containing a circular reference.

Usage

var isCircularArray = require( '@stdlib/assert/is-circular-array' );

isCircularArray( value )

Tests if a value is an array containing a circular reference.

var arr = [ 1, 2, 3 ];
var bool = isCircularArray( arr );
// returns false

arr.push( arr );
bool = isCircularArray( arr );
// returns true

arr.pop();
arr.self = arr;
bool = isCircularArray( arr );
// returns true

Examples

var isCircularArray = require( '@stdlib/assert/is-circular-array' );

var arr = [ 1, 2, 3 ];
arr.push( arr );
console.log( isCircularArray( arr ) );
// => true

var obj = {
    'beep': 'boop'
};
obj.self = obj;
console.log( isCircularArray( obj ) );
// => false

console.log( isCircularArray( [] ) );
// => false

console.log( isCircularArray( null ) );
// => false