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

@randajan/props

v0.1.2

Published

Lightweight JavaScript library that simplifies working with Object.defineProperty and Object.defineProperties. It provides intuitive, easy-to-use functions for defining solid, virtual, safe, and cached properties on objects. With this library, you can man

Downloads

11

Readme

@randajan/props

NPM JavaScript Style Guide

Lightweight JavaScript library that simplifies working with Object.defineProperty and Object.defineProperties. It provides intuitive, easy-to-use functions for defining solid, virtual, safe, and cached properties on objects. With this library, you can manage object properties more efficiently, using less code and achieving better readability.

Install

npm install @randajan/props

or

yarn add @randajan/props

Basics

This library provides simplified utilities to define properties on objects with specific behaviors, using four main functions:

  1. solid: Creates a straightforward property with a fixed value.
  2. virtual: Defines a virtual (getter-only) property.
  3. safe: Creates a property with custom getter and setter that reads/writes to a private storage.
  4. cached: Defines a property that initializes its value on the first read and caches it.

solid(...) && solids(...)

Defines a property with a fixed, unchangeable value on an object.

Parameters

  • obj (Object): The target object to which the property will be added.
  • name (String): The name of the property.
  • value (Any): The value of the property.
  • enumerable (Boolean, default: true): Determines if the property shows up in enumerations.
  • configurable (Boolean, default: false): Determines if the property can be redefined or deleted.

Example


solid(myObject, 'constantProp', 42, true, false);

virtual(...) && virtuals(...)

Defines a virtual property, accessible via a getter function, without storing any value on the object.

Parameters

  • obj (Object): The target object to which the property will be added.
  • name (String): The name of the property.
  • get (Function): A function that returns the value when the property is accessed.
  • enumerable (Boolean, default: true): Determines if the property shows up in enumerations.
  • configurable (Boolean, default: false): Determines if the property can be redefined or deleted.

Example


virtual(myObject, 'dynamicProp', () => Math.random(), true, false);

safe(...) && safes(...)

Defines a property with custom getter and setter functions that interact with a private object, priv, allowing for controlled access to a hidden value.

Parameters

  • obj (Object): The target object to which the property will be added.
  • priv (Object): A private object storing values.
  • name (String): The name of the property.
  • set (Function | null): A function to process and set the value on priv (receives new value, current value, and name).
  • get (Function | null): A function that retrieves the value from priv (receives current value and name).
  • enumerable (Boolean, default: true): Determines if the property shows up in enumerations.
  • configurable (Boolean, default: false): Determines if the property can be redefined or deleted.

Example


const priv = { hiddenValue: 100 };
safe(myObject, priv, 'secureProp', 
    (newValue) => newValue * 2, 
    (value) => value + 1, 
    true, false);

cached(...) && cacheds(...)

Creates a property that is initialized lazily, using a reset function upon the first access, and caches this value within a private object.

Parameters

  • obj (Object): The target object to which the property will be added.
  • priv (Object): A private object storing the cached values.
  • name (String): The name of the property.
  • reset (Function): A function that provides the initial value upon the first access.
  • get (Function | null): A function that retrieves the value (receives the stored value and name).
  • enumerable (Boolean, default: true): Determines if the property shows up in enumerations.
  • configurable (Boolean, default: false): Determines if the property can be redefined or deleted.

Example


const priv = {};
cached(myObject, priv, 'lazyProp', 
    () => Date.now(),  // Reset only called once on first access
    (value) => `Timestamp: ${value}`, 
    true, false);

Happy hacking

License

MIT © randajan

@randajan/props - Access Points Overview