main.js (1610B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 // MODULES // 22 23 var isPlainObject = require( './../../is-plain-object' ); 24 var isCircular = require( './../../is-circular' ); 25 26 27 // MAIN // 28 29 /** 30 * Tests if a value is a plain object containing a circular reference. 31 * 32 * @param {*} value - value to test 33 * @returns {boolean} boolean indicating whether value is a plain object containing a circular reference 34 * 35 * @example 36 * var obj = { 37 * 'a': 'beep', 38 * 'b': { 39 * 'c': 'boop' 40 * } 41 * }; 42 * obj.b.self = obj; 43 * var bool = isCircularPlainObject( obj ); 44 * // returns true 45 * 46 * @example 47 * var arr = [ 1, 2, 3 ]; 48 * arr.push( arr ); 49 * var bool = isCircularPlainObject( arr ); 50 * // returns false 51 * 52 * @example 53 * var bool = isCircularPlainObject( {} ); 54 * // returns false 55 * 56 * @example 57 * var bool = isCircularPlainObject( null ); 58 * // returns false 59 */ 60 function isCircularPlainObject( value ) { 61 if ( !isPlainObject( value ) ) { 62 return false; 63 } 64 return isCircular( value, [] ); 65 } 66 67 68 // EXPORTS // 69 70 module.exports = isCircularPlainObject;