describe-property


describe-property is a property descriptor library that runs in both node.js and the browser. You use it to quickly generate property descriptors to use with Object.create, Object.defineProperty, and/or Object.defineProperties.

$3

``js
var d = require('describe-property');

function Person(firstName, surname) {
this.firstName = firstName;
this.surname = surname;
}

Object.defineProperties(Person.prototype, {

// Methods can be passed directly.
sayHi: d(function () {
console.log('Hello, my name is', this.fullName);
}),

// Getters are defined using d.gs.
fullName: d.gs(function () {
return this.firstName + ' ' + this.surname;
}),

// Setters are defined as the second argument to d.gs.
firstName: d.gs(function () {
return this._firstName;
}, function (value) {
this._firstName = value.trim();
})

});
`

By default property descriptors use ES5 attributes.

`js
{
configurable: true,
enumerable: false,
writable: true
}
`

But any of these can be overridden using an object literal.

`js
d({
enumerable: true,
value: function () {
// ...
}
}); // => { configurable: true, enumerable: true, writable: true, value: function () {} }
``

$3

Using npm:

$ npm install describe-property

$3

Please file issues on the issue tracker on GitHub.

$3

To run the tests in node:

$ npm install
$ npm test

$3

This library was inspired by @medikoo's excellent d library. It is intended to be a lighter-weight alternative with fewer features, but also only a single dependency.

$3

MIT