time-to-botec/squiggle/node_modules/@stdlib/assert/is-circular-plain-object/docs/repl.txt

30 lines
540 B
Plaintext
Raw Normal View History

{{alias}}( value )
Tests if a value is a plain object containing a circular reference.
Parameters
----------
value: any
Value to test.
Returns
-------
bool: boolean
Boolean indicating whether value is a plain object containing a
circular reference.
Examples
--------
> var obj = { 'beep': 'boop' };
> obj.self = obj;
> var bool = {{alias}}( obj )
true
> bool = {{alias}}( {} )
false
> bool = {{alias}}( null )
false
See Also
--------