main.js (1336B)
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 defineProperty = require( './../../define-property' ); 24 25 26 // MAIN // 27 28 /** 29 * Defines a read-only accessor. 30 * 31 * @param {Object} obj - object on which to define the property 32 * @param {(string|symbol)} prop - property name 33 * @param {Function} getter - accessor 34 * 35 * @example 36 * function getter() { 37 * return 'bar'; 38 * } 39 * 40 * var obj = {}; 41 * 42 * setReadOnlyAccessor( obj, 'foo', getter ); 43 * 44 * try { 45 * obj.foo = 'boop'; 46 * } catch ( err ) { 47 * console.error( err.message ); 48 * } 49 */ 50 function setReadOnlyAccessor( obj, prop, getter ) { 51 defineProperty( obj, prop, { 52 'configurable': false, 53 'enumerable': true, 54 'get': getter 55 }); 56 } 57 58 59 // EXPORTS // 60 61 module.exports = setReadOnlyAccessor;