time-to-botec/js/node_modules/@stdlib/assert/is-circular-array/docs/repl.txt

30 lines
522 B
Plaintext
Raw Normal View History

{{alias}}( value )
Tests if a value is an array containing a circular reference.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether value is an array containing a
circular reference.
Examples
--------
> var arr = [ 1, 2, 3 ];
> arr.push( arr );
> var bool = {{alias}}( arr )
true
> bool = {{alias}}( [] )
false
> bool = {{alias}}( null )
false
See Also
--------