index.js (1146B)
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 /** 22 * Define a read-only accessor. 23 * 24 * @module @stdlib/utils/define-read-only-accessor 25 * 26 * @example 27 * var setReadOnlyAccessor = require( '@stdlib/utils/define-read-only-accessor' ); 28 * 29 * function getter() { 30 * return 'bar'; 31 * } 32 * 33 * var obj = {}; 34 * 35 * setReadOnlyAccessor( obj, 'foo', getter ); 36 * 37 * try { 38 * obj.foo = 'boop'; 39 * } catch ( err ) { 40 * console.error( err.message ); 41 * } 42 */ 43 44 // MODULES // 45 46 var setReadOnlyAccessor = require( './main.js' ); 47 48 49 // EXPORTS // 50 51 module.exports = setReadOnlyAccessor;