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

Export assignment setReadOnly

• setReadOnly(obj: any, prop: PropertyName, value: any): void

• Defines a read-only property.

  Notes

  • Read-only properties are enumerable and non-configurable.

  Parameters

  • obj: any

    object on which to define the property

  • prop: PropertyName

    property name

  • value: any

    value to set

  Returns void

  Example

  var obj = {};
  
  setReadOnly( obj, 'foo', 'bar' );
  
  try {
      obj.foo = 'boop';
  } catch ( err ) {
      console.error( err.message );
  }