time-to-botec/js/node_modules/@stdlib/assert/is-read-write-property-in/lib/main.js
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

79 lines
1.7 KiB
JavaScript

/**
* @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';
// MODULES //
var propertyDescriptorIn = require( '@stdlib/utils/property-descriptor-in' );
// MAIN //
/**
* Tests if an object's own or inherited property is readable and writable.
*
* @param {*} value - value to test
* @param {*} property - property to test
* @returns {boolean} boolean indicating if an object property is readable and writable
*
* @example
* var defineProperty = require( '@stdlib/utils/define-property' );
*
* var obj = {
* 'boop': true
* };
*
* function setter( v ) {
* obj.boop = v;
* }
*
* defineProperty( obj, 'beep', {
* 'configurable': false,
* 'enumerable': false,
* 'set': setter
* });
*
* var bool = isReadWritePropertyIn( obj, 'boop' );
* // returns true
*
* bool = isReadWritePropertyIn( obj, 'beep' );
* // returns false
*/
function isReadWritePropertyIn( value, property ) {
var desc = propertyDescriptorIn( value, property );
return (
desc !== null &&
(
// Data descriptor:
desc.writable === true ||
// Accessor descriptor:
(
typeof desc.get === 'function' &&
typeof desc.set === 'function'
)
)
);
}
// EXPORTS //
module.exports = isReadWritePropertyIn;