Narwhals Poke Mammals

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

    0.0.7 • Public • Published

    isCircular

    NPM version Build Status Coverage Status

    Test if an object-like value contains a circular reference.

    Installation

    npm install @stdlib/assert-is-circular

    Usage

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

    isCircular( value )

    Test if an object-like value contains a circular reference.

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

    Notes

    • Object-like values include objects (except for null), arrays, functions, regular expressions, Date objects, and any other JavaScript object to which properties may be bound.

    Examples

    var isCircular = require( '@stdlib/assert-is-circular' );
    
    var obj1 = {
        'a': 'beep',
        'b': {
            'c': 'boop'
        }
    };
    obj1.b.self = obj1;
    var bool = isCircular( obj1 );
    // returns true
    
    var obj2 = {
        'a': {},
        'b': obj1
    };
    bool = isCircular( obj2 );
    // returns true
    
    var arr = [ 1, 2, 3 ];
    arr.push( arr );
    bool = isCircular( arr );
    // returns true
    
    function circ() {}
    circ.self = circ;
    bool = isCircular( circ );
    // returns true
    
    var obj3 = {
        'beep': 'boop'
    };
    bool = isCircular({
        'a': obj3,
        'b': obj3
    });
    // returns false
    
    bool = isCircular( {} );
    // returns false
    
    bool = isCircular( 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

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    101

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    38.8 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser