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

private-scope

v1.0.0

Published

Give javascript objects a private scope which only internal functions on the object may access (this.private).

Downloads

5

Readme

Build Status

##What is this?

This module gives javacript objects a private only scope.

##Examples

Regular JavaScript objects:

require('private-scope');

const test = {
  getX: function() {
    return this.private.x;
  },
  setX: function(x) {
    this.private.x = x;
  }
};

test.private.x = 5; // TypeError: cannot find x of undefined
test.setX(100);
console.log(test.private.x); // TypeError: cannot find x of undefined
console.log(test.getX()); // 100

Classes:

require('private-scope');

class TestClass {
  getX() {
    return this.private.x;
  }
  setX(x) {
    this.private.x = x;
  }
  constructor() {
    this.private.y = 2;
  }
};

const test = new TestClass();
test.private.x = 5; // TypeError: cannot find x of undefined
test.setX(100);
console.log(test.private.x); // TypeError: cannot find x of undefined
console.log(test.getX()); // 100

Prototypes:

require('private-scope');

function TestClass() {
  this.private.y = 53;
}

TestClass.prototype.getX = function() {
  return this.private.x;
}

TestClass.prototype.setX = function(x) {
  this.private.x = x;
}

TestClass.prototype.getY = function() {
  return this.private.y;
}

const test = new TestClass();
test.private.x = 5; // TypeError: cannot find x of undefined
test.setX(100);
console.log(test.private.x); // TypeError: cannot find x of undefined
console.log(test.getX()); // 100
console.log(test.getY()); // 53

##Why?

Lets say you organized your object like so:

const test = {

  private: {},

  getX: function() {
    return this.private.x;
  },

  setX: function(x) {
    this.private.x = x;
  }

};

Sure you can do test.getX() and test.setX(12) here but you can just as easily do test.private.x and there’s nothing stopping you from doing the latter even outside of an internal function on test such as from within getX and setX. After you include this module into your project, test.private.x is not allowed.

##Are You Crazy?

Probably. And my solution isn't bulletproof. This solution leverages Function.caller behind the scenes so things can get funky when that's not available. I'm using a slight workaround for objects created via the class keyword too (stack inspection) to determine if a caller belongs to a class due to the absence of Function.caller in methods created using class.