npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

predefine

v0.1.3

Published

Predefine your Object.defineProperties to create a more human readable API.

Downloads

69,127

Readme

predefine

Node.js CI

When creating objects or prototypes using Object.defineProperties or Object.defineProperty it make your code look really verbose by all the property descriptions that it needs. Most of the time, they are the same. They either make your properties writable, readable or prevents them from being enumerable. So basically:

Predefine makes Object.defineProperties your human readable and manageable.

Installation

npm install --save predefine

Getting started

Let's start with a basic example of predefine usage:

var predefine = require('predefine');

function Base() {
  var readable = predefine(this, { configurable: false, enumerable: false })
    , writable = predefine(this, predefine.WRITABLE);

  readable('prop', 'value');
  writable('data', []);
}

Base.writable = predefine(Base.prototype, predefine.WRITABLE);

Base.writable('foo', 'bar');

As you can see from the snippet above, it's really easy to see which properties are made readable and which one's are writable.

Predefine.extend

This allows you to add Backbone inspired .extend functionality to your constructors. This makes inheriting a lot easier and readable. See the extendible module in npm for information.

function Foo() {}
Foo.extend = predefine.extend;

var Bar = Foo.extend({
  method: function () {}
});

Predefine.descriptor

Test if a given object is a valid Object description to it can be used with Object.defineProperty, Object.defineProperties and Object.create.

predefine.descriptor({ foo: 'bar' });                       // false
predefine.descriptor({ value: 'bar' });                     // true
predefine.descriptor({ value: 'bar', enumerable: false });  // true
predefine.descriptor({ value: 'bar', foo: 'bar' });         // false

Predefine.create

This is a simple helper function to create descriptions that can be used within Object.create and Object.defineProperties.

var data = Object.create(null, predefine.create('foo', {
  value: 'bar'
}));

var data = Object.create(null, predefine.create('foo', {
  value: 'bar'
}, predefine.READABLE));

var data = Object.create(null, predefine.create('foo', 'bar', predefine.READABLE));

Predefine.remove

Removes all enumerable properties from a given object, with the ability to keep white listed properties.

var data = { foo: 'bar', bar: 'foo' };

predefine.remove(data);           // The data variable is now an empty object.
predefine.remove(data, ['foo']);  // The foo property is kept.

var readable(data);
readable('baz', 'baz');

predefine.remove(data);           // Only `baz` is left.

Predefine.merge

Merge two objects in to one single object. This supports deep merging.

var result = predefine.merge({ foo: 'bar' }, { bar: 'foo' });

Predefine.mixin

Mixin two Objects, which also transfers properties that are set using Object.defineProperty.

var result = predefine.mixin({ foo: 'bar' }, { bar: 'foo' });

License

MIT