time-to-botec/squiggle/node_modules/@stdlib/assert/is-read-only-property-in/lib/index.js

56 lines
1.3 KiB
JavaScript
Raw Normal View History

/**
* @license Apache-2.0
*
* Copyright (c) 2018 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.
*/
'use strict';
/**
* Test whether an object's own or inherited property is read-only.
*
* @module @stdlib/assert/is-read-only-property-in
*
* @example
* var defineProperty = require( '@stdlib/utils/define-property' );
* var isReadOnlyPropertyIn = require( '@stdlib/assert/is-read-only-property-in' );
*
* var obj = {
* 'boop': true
* };
*
* defineProperty( obj, 'beep', {
* 'configurable': false,
* 'enumerable': true,
* 'writable': false,
* 'value': true
* });
*
* var bool = isReadOnlyPropertyIn( obj, 'boop' );
* // returns false
*
* bool = isReadOnlyPropertyIn( obj, 'beep' );
* // returns true
*/
// MODULES //
var isReadOnlyPropertyIn = require( './main.js' );
// EXPORTS //
module.exports = isReadOnlyPropertyIn;