1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
|
/*
* @license Apache-2.0
*
* Copyright (c) 2021 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// TypeScript Version: 2.0
/**
* Tests if a value is a plain object containing a circular reference.
*
* @param value - value to test
* @returns 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
*/
declare function isCircularPlainObject( value: any ): boolean;
// EXPORTS //
export = isCircularPlainObject;
|