time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

main.js (1661B)


      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 propertyDescriptor = require( '@stdlib/utils/property-descriptor' );
     24 
     25 
     26 // MAIN //
     27 
     28 /**
     29 * Tests if an object's own property is write-only.
     30 *
     31 * @param {*} value - value to test
     32 * @param {*} property - property to test
     33 * @returns {boolean} boolean indicating if an object property is write-only
     34 *
     35 * @example
     36 * var defineProperty = require( '@stdlib/utils/define-property' );
     37 *
     38 * var obj = {
     39 *     'boop': true
     40 * };
     41 *
     42 * function setter( v ) {
     43 *     obj.boop = v;
     44 * }
     45 *
     46 * defineProperty( obj, 'beep', {
     47 *     'configurable': false,
     48 *     'enumerable': true,
     49 *     'set': setter
     50 * });
     51 *
     52 * var bool = isWriteOnlyProperty( obj, 'boop' );
     53 * // returns false
     54 *
     55 * bool = isWriteOnlyProperty( obj, 'beep' );
     56 * // returns true
     57 */
     58 function isWriteOnlyProperty( value, property ) {
     59 	var desc = propertyDescriptor( value, property );
     60 	return (
     61 		desc !== null &&
     62 		desc.configurable === false &&
     63 		(
     64 			typeof desc.set === 'function' &&
     65 			desc.get === void 0
     66 		)
     67 	);
     68 }
     69 
     70 
     71 // EXPORTS //
     72 
     73 module.exports = isWriteOnlyProperty;