@ipld/is-circular/index.js

high-performance, zero-dependency circular reference check for objects (or arrays)

var Node = require('./lib/node')

module.exports = isCircular

/**
 * checks whether the object is circular
 * @param {object}  obj - object to check circularity for
 * @param {Object<string, true>} ignore - dictionary who's keys will be ignored
 * @return {Boolean} true if obj is circular, false if it is not
 */
function isCircular (obj, ignore={}) {
  if (!(obj instanceof Object)) {
    throw new TypeError('"obj" must be an object (or inherit from it)')
  }
  return _isCircular(obj, ignore)
}

/**
 * @private
 * checks whether the object is circular
 * @param {object}  obj - object to check circularity for
 * @param {Object<string, true>} ignore - dictionary who's keys will be ignored
 * @param {Node}    parentList - linked-list that contains all the object's parents
 * @return {Boolean} true if obj is circular, false if it is not
 */
function _isCircular (obj, ignore, parentList) {
  parentList = new Node(obj, parentList)

  // breadth-first search for circular object
  for (var key in obj) {
    if (ignore[key]) {
      continue
    }

    var val = obj[key]
    if (val instanceof Object) {
      if (parentList.contains(val) || _isCircular(val, ignore, parentList)) {
        return true
      }
    }
  }

  return false
}