67 lines
2.1 KiB
JavaScript
67 lines
2.1 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 hasOwnProp = require( '@stdlib/assert/has-own-property' );
|
||
|
|
|
||
|
|
|
||
|
|
// MAIN //
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns a property descriptor for an object's own property.
|
||
|
|
*
|
||
|
|
* ## Notes
|
||
|
|
*
|
||
|
|
* - In contrast to the built-in `Object.getOwnPropertyDescriptor()`, this function returns `null` if provided `undefined` or `null`, rather than throwing an error.
|
||
|
|
* - In contrast to the built-in `Object.getOwnPropertyDescriptor()`, this function returns `null` if an object does not have a provided property, rather than `undefined`.
|
||
|
|
* - In environments lacking `Object.getOwnPropertyDescriptor()` support, property descriptors do not exist. In non-supporting environment, if an object has a provided property, this function returns a descriptor object equivalent to that returned in a supporting environment; otherwise, the function returns `null`.
|
||
|
|
*
|
||
|
|
* @private
|
||
|
|
* @param {*} value - input object
|
||
|
|
* @param {(string|symbol)} property - property
|
||
|
|
* @returns {(Object|null)} property descriptor or null
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var obj = {
|
||
|
|
* 'beep': 'boop',
|
||
|
|
* 'foo': 3.14
|
||
|
|
* };
|
||
|
|
*
|
||
|
|
* var desc = getOwnPropertyDescriptor( obj, 'foo' );
|
||
|
|
* // returns {'configurable':true,'enumerable':true,'writable':true,'value':3.14}
|
||
|
|
*/
|
||
|
|
function getOwnPropertyDescriptor( value, property ) {
|
||
|
|
if ( hasOwnProp( value, property ) ) {
|
||
|
|
return {
|
||
|
|
'configurable': true,
|
||
|
|
'enumerable': true,
|
||
|
|
'writable': true,
|
||
|
|
'value': value[ property ]
|
||
|
|
};
|
||
|
|
}
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
// EXPORTS //
|
||
|
|
|
||
|
|
module.exports = getOwnPropertyDescriptor;
|