External module "utils/define-property/docs/types/index.d"

Export assignment defineProperty

• defineProperty(obj: any, prop: PropertyName, descriptor: PropertyDescriptor): any

• 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.

  Parameters

  • obj: any

    object on which to define the property

  • prop: PropertyName

    property name

  • descriptor: PropertyDescriptor

    property descriptor

  Returns any

  object with added property

  Example

  var obj = {};
  
  defineProperty( obj, 'foo', {
      'value': 'bar'
  });
  
  var str = obj.foo;
  // returns 'bar'