Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

describe-property

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

describe-property

Define JavaScript object properties quickly with ES5 defaults

  • 1.1.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
4.5K
decreased by-16.03%
Maintainers
1
Weekly downloads
 
Created
Source

npm package build status dependency status code climate

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.

Example

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.

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

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

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

Installation

Using npm:

$ npm install describe-property

Issues

Please file issues on the issue tracker on GitHub.

Tests

To run the tests in node:

$ npm install
$ npm test

Credits

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.

License

MIT

Keywords

FAQs

Package last updated on 19 Jan 2015

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc