Neanderthal Painting Monet

    @stdlib/assert-is-circular-plain-object
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    isCircularPlainObject

    NPM version Build Status Coverage Status

    Test if a value is a plain object containing a circular reference.

    Installation

    npm install @stdlib/assert-is-circular-plain-object

    Usage

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

    isCircularPlainObject( value )

    Tests if a value is a plain object containing a circular reference.

    var obj = {
        'beep': 'boop'
    };
    var bool = isCircularPlainObject( obj );
    // returns false
    
    obj.self = obj;
    bool = isCircularPlainObject( obj );
    // returns true

    Examples

    var isCircularPlainObject = require( '@stdlib/assert-is-circular' );
    
    var obj1 = {
        'a': 'beep',
        'b': {
            'c': 'boop'
        }
    };
    obj1.b.self = obj1;
    var bool = isCircularPlainObject( obj1 );
    // returns true
    
    var obj2 = {
        'a': {},
        'b': obj1
    };
    bool = isCircularPlainObject( obj2 );
    // returns true
    
    var arr = [ 1, 2, 3 ];
    arr.push( arr );
    bool = isCircularPlainObject( arr );
    // returns false
    
    var obj3 = {
        'beep': 'boop'
    };
    bool = isCircularPlainObject({
        'a': obj3,
        'b': obj3
    });
    // returns false
    
    bool = isCircularPlainObject( {} );
    // returns false
    
    bool = isCircularPlainObject( null );
    // returns false

    See Also


    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.

    Community

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

    npm i @stdlib/assert-is-circular-plain-object

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    18

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    37.4 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser