62 lines
2.9 KiB
JavaScript
62 lines
2.9 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';
|
|
|
|
// MAIN //
|
|
|
|
/**
|
|
* Defines (or modifies) an object property.
|
|
*
|
|
* ## Notes
|
|
*
|
|
* - Property descriptors come in two flavors: **data descriptors** and **accessor descriptors**. A data descriptor is a property that has a value, which may or may not be writable. An accessor descriptor is a property described by a getter-setter function pair. A descriptor must be one of these two flavors and cannot be both.
|
|
*
|
|
* @name defineProperty
|
|
* @type {Function}
|
|
* @param {Object} obj - object on which to define the property
|
|
* @param {(string|symbol)} prop - property name
|
|
* @param {Object} descriptor - property descriptor
|
|
* @param {boolean} [descriptor.configurable=false] - boolean indicating if property descriptor can be changed and if the property can be deleted from the provided object
|
|
* @param {boolean} [descriptor.enumerable=false] - boolean indicating if the property shows up when enumerating object properties
|
|
* @param {boolean} [descriptor.writable=false] - boolean indicating if the value associated with the property can be changed with an assignment operator
|
|
* @param {*} [descriptor.value] - property value
|
|
* @param {(Function|void)} [descriptor.get=undefined] - function which serves as a getter for the property, or, if no getter, undefined. When the property is accessed, a getter function is called without arguments and with the `this` context set to the object through which the property is accessed (which may not be the object on which the property is defined due to inheritance). The return value will be used as the property value.
|
|
* @param {(Function|void)} [descriptor.set=undefined] - function which serves as a setter for the property, or, if no setter, undefined. When assigning a property value, a setter function is called with one argument (the value being assigned to the property) and with the `this` context set to the object through which the property is assigned.
|
|
* @throws {TypeError} first argument must be an object
|
|
* @throws {TypeError} third argument must be an object
|
|
* @throws {Error} property descriptor cannot have both a value and a setter and/or getter
|
|
* @returns {Object} object with added property
|
|
*
|
|
* @example
|
|
* var obj = {};
|
|
*
|
|
* defineProperty( obj, 'foo', {
|
|
* 'value': 'bar'
|
|
* });
|
|
*
|
|
* var str = obj.foo;
|
|
* // returns 'bar'
|
|
*/
|
|
var defineProperty = Object.defineProperty;
|
|
|
|
|
|
// EXPORTS //
|
|
|
|
module.exports = defineProperty;
|