Package Exports

@stdlib/assert-is-circular-array

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/assert-is-circular-array) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

isCircularArray

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

Installation

npm install @stdlib/assert-is-circular-array

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

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

License

See LICENSE.

@stdlib/assert-is-circular-array