External module "assert/is-circular-plain-object/docs/types/index.d"

Export assignment isCircularPlainObject

• isCircularPlainObject(value: any): boolean

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

  Parameters

  • value: any

    value to test

  Returns boolean

  boolean indicating whether value is a plain object containing a circular reference

  Example

  var obj = {
    'a': 'beep',
    'b': {
      'c': 'boop'
    }
  };
  obj.b.self = obj;
  var bool = isCircularPlainObject( obj );
  // returns true

  Example

  var arr = [ 1, 2, 3 ];
  arr.push( arr );
  var bool = isCircularPlainObject( arr );
  // returns false

  Example

  var bool = isCircularPlainObject( {} );
  // returns false

  Example

  var bool = isCircularPlainObject( null );
  // returns false