Object.defineProperties()

Object.defineProperties() 메서드는 객체에 새로운 속성을 정의하거나 기존의 속성을 수정하고, 그 객체를 반환한다.

The source for this interactive example is stored in a GitHub repository. If you'd like to contribute to the interactive examples project, please clone https://github.com/mdn/interactive-examples and send us a pull request.

문법

Object.defineProperties(obj, props)

인자

obj

속성을 정의하거나 수정할 객체.

props

정의하거나 수정할 속성의 이름을 키로, 그 속성을 서술하는 객체를 값으로 갖는 객체. props의 각 값은 데이터 서술자(data descriptor) 혹은 접근자 서술자(accessor descriptor) 중 하나여야 하며, 동시에 두 유형을 포함할 수 없다(Object.defineProperty() 참조).

데이터 서술자와 접근자 서술자 모두 다음 키를 선택적으로 포함할 수 있다:

configurable

true일 경우 이 속성 서술자의 형태를 변경하거나, 속성을 해당 객체에서 삭제할 수 있다.
기본값은 false이다.

enumerable

true일 경우 해당 객체의 속성을 열거할 때 이 속성이 열거된다.
기본값은 false이다.

데이터 서술자의 경우 다음 키를 추가로 포함할 수 있다:

value

이 속성에 설정할 값. 올바른 자바스크립트 값(숫자, 객체, 함수 등)이면 무엇이든 설정할 수 있다.
기본값은 undefined이다.

writable

true일 경우 이 속성에 설정된 값을 할당 연산자로 수정할 수 있다.
기본값은 false이다.

접근자 서술자의 경우 다음 키를 추가로 포함할 수 있다:

get

해당 속성의 getter가 될 함수, 혹은 getter가 없을 경우 undefined. 이 함수의 반환값이 속성의 값으로 사용된다.
기본값은 undefined이다.

set

해당 속성의 setter가 될 함수, 혹은 setter가 없을 경우 undefined. 이 함수는 이 속성에 할당되는 새로운 값을 유일한 인자로 받는다.
기본값은 undefined이다.

서술자가 value, writable, get, set 키를 모두 가지고 있지 않을 경우 데이터 서술자로 취급한다. 서술자가 value이나 writable과 get이나 set 키를 모두 가지고 있을 경우 예외가 발생한다.

반환값

함수에 넘겨주었던 객체.

설명

Object.defineProperties는 기본적으로 props의 모든 열거가능한 속성에 따라 객체 obj의 속성을 정의한다.

예시

var obj = {};
Object.defineProperties(obj, {
  'property1': {
    value: true,
    writable: true
  },
  'property2': {
    value: 'Hello',
    writable: false
  }
  // 등등
});

폴리필

모든 이름과 속성이 원래 값을 가리키는 깨끗한 실행 환경에서 Object.defineProperties는 다음 자바스크립트 재구현과 거의 완벽하게 똑같이(isCallable의 주석에 주목) 실행된다.

function defineProperties(obj, properties) {
  function convertToDescriptor(desc) {
    function hasProperty(obj, prop) {
      return Object.prototype.hasOwnProperty.call(obj, prop);
    }

    function isCallable(v) {
      // NB: 함수가 아닌 값이 호출가능할 경우 필요할 시 수정할 것
      return typeof v === 'function';
    }

    if (typeof desc !== 'object' || desc === null)
      throw new TypeError('bad desc');

    var d = {};

    if (hasProperty(desc, 'enumerable'))
      d.enumerable = !!desc.enumerable;
    if (hasProperty(desc, 'configurable'))
      d.configurable = !!desc.configurable;
    if (hasProperty(desc, 'value'))
      d.value = desc.value;
    if (hasProperty(desc, 'writable'))
      d.writable = !!desc.writable;
    if (hasProperty(desc, 'get')) {
      var g = desc.get;

      if (!isCallable(g) && typeof g !== 'undefined')
        throw new TypeError('bad get');
      d.get = g;
    }
    if (hasProperty(desc, 'set')) {
      var s = desc.set;
      if (!isCallable(s) && typeof s !== 'undefined')
        throw new TypeError('bad set');
      d.set = s;
    }

    if (('get' in d || 'set' in d) && ('value' in d || 'writable' in d))
      throw new TypeError('identity-confused descriptor');

    return d;
  }

  if (typeof obj !== 'object' || obj === null)
    throw new TypeError('bad obj');

  properties = Object(properties);

  var keys = Object.keys(properties);
  var descs = [];

  for (var i = 0; i < keys.length; i++)
    descs.push([keys[i], convertToDescriptor(properties[keys[i]])]);

  for (var i = 0; i < descs.length; i++)
    Object.defineProperty(obj, descs[i][0], descs[i][1]);

  return obj;
}

명세

브라우저 지원 현황

같이 보기

• Object.defineProperty()
• Object.keys()
• Enumerability and ownership of properties