Test if a value is an array containing a circular reference.
npm install @stdlib/assert-is-circular-arrayWe believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js. The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases. When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there. To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Test if a value is an array containing a circular reference.
``bash`
npm install @stdlib/assert-is-circular-array
`javascript`
var isCircularArray = require( '@stdlib/assert-is-circular-array' );
#### isCircularArray( value )
Tests if a value is an array containing a circular reference.
`javascript
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
`
`javascript
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
`
*
- [@stdlib/assert-is-circular][@stdlib/assert/is-circular]: test if an object-like value contains a circular reference.
- [@stdlib/assert-is-circular-plain-object][@stdlib/assert/is-circular-plain-object]: test if a value is a plain object containing a circular reference.
*
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/assert-is-circular-array.svg
[npm-url]: https://npmjs.org/package/@stdlib/assert-is-circular-array
[test-image]: https://github.com/stdlib-js/assert-is-circular-array/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/assert-is-circular-array/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/assert-is-circular-array/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/assert-is-circular-array?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/assert-is-circular-array/tree/deno
[deno-readme]: https://github.com/stdlib-js/assert-is-circular-array/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/assert-is-circular-array/tree/umd
[umd-readme]: https://github.com/stdlib-js/assert-is-circular-array/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/assert-is-circular-array/tree/esm
[esm-readme]: https://github.com/stdlib-js/assert-is-circular-array/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/assert-is-circular-array/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/assert-is-circular-array/main/LICENSE
[@stdlib/assert/is-circular]: https://www.npmjs.com/package/@stdlib/assert-is-circular
[@stdlib/assert/is-circular-plain-object]: https://www.npmjs.com/package/@stdlib/assert-is-circular-plain-object