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

def

v0.0.8

Published

A JavaScript library for creating complex objects and properties, intuitively.

Downloads

857

Readme

Basic Usage

named function only

myObj.def(function namedFunction(){});
 // -> //gets name from function itself, can only be named in source or with eval, not dynamic
  { namedFunction: Function namedFunction }

property name and any value

myObj.def('myProp', 5000);
 // -> // simple property, config/enum/write = true
  { myProp: 5000 }

getter/setter non-backward compatible syntax

myObj.def({
  get myProp(){ return 5000; },
  set myProp(val){ 'some setter logic'; }
});
 // ->
  { myProp: [Getter/Setter] }

Controlling enumerable, writable, configurable

non-enumerable

myObj.def('_hiddenProp', 'somevalue');
 // -> //non-enumerable, invisible unless you use getOwnPropertyNames, '_' sliced
  { [hiddenProp]: 'somevalue' }

non-configurable

myObj.def(function $superImportantFunction(){});
 // -> //non-configurable (no delete or redefine), '$' sliced
  { [superImportantFunction]: Function $superImportantFunction }

non-writable

myObj.def('SOMECONSTANT', 'this value is constant');
 // -> //non-writable (can still be changed using configurability, AKA delete and redefine)
  { SOMECONSTANT: 'this value is constant' }

Multiple properties, still using above rules

dict

myObj.def({
  property1: 'simpleValue',
  get prop2(){ return 'get/setter using non-backcompat syntax' },
  set prop2(val){ this.powerLevel = 9001; },
  _someFunc: function(){ console.log("can't effectively use named functions with a dict =(") }
});
 // ->
  { property1: 'simplValue',
    prop2: [Getter/Setter],
    [someFunc]: Function }

array of named functions

myObj.def([
  function firstFunction(){ console.log('whatever:' + this); },
  function getSecrets(){ return getSecretsFromDB('teehee'); },
  function setSecrets(val){ sendSecretsToDB(val); },
  function _stealSecretsForBlackMarket(){ return getAllSecretsFromDB_unlogged(); },
]);
 // ->
  { firstFunction: Function firstFunction,
    Secrets: [Getter/Setter],
    [stealSecretsForBlackMarket]: Function _stealSecretsForBlackMarket }

Private variables

Private values are detected by the existence of an extra parameter on the get or set functions. These aren't valid getters and setters to JavaScript but they will be wrapped such that they share a private value inaccessible from anywhere else, but shared between the getter and setter functions. The private value is passed in each time, along with the passed in value for setters.

myObj.def({
  myPrivate: {
    get: function(privateValue){
      return privateValue.somePublicProperty;
    },
    set: function(privateValue, newValue){
      if (newValue.secreyKey === privateValue.unlockKey)
        return newValue;
      } else {
        return privateValue.somePublicProperty;
      }
    }
  }
})