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

ns-props

v1.0.0

Published

Namespaced props

Downloads

38

Readme

ns-props

Namespaced props (or nice props).

Getting Started

Install the package with this command:

npm install ns-props --save

Then you can require the package with require('ns-props').

What does this do?

This lightweight module contains 3 methods for operating on "namespaced" properties: has, get, and set. They do exactly what their names indicate; look below for examples.

Why / when should I use it?

This is a utility lib created for another project of mine, where I needed to handle dynamic "namespaces". If you don't know beforehand what "namespaces" will be used, then this lib is for you.

If all your "namespaces" are static, then you probably don't need to and shouldn't use this library. Referencing raw properties is always a lot faster.

Why use quotation marks everywhere?

JavaScript does not have a built-in concept of a "namespace" and this is just one take on what "namespaces" can be in JS. Hence the quotation marks.

Examples

var nsProps = require('ns-props');

var obj = {};

nsProps.has(obj, 'ns.prop'); // false

nsProps.set(obj, 'ns.prop', 'value'); // obj is { ns: { prop: 'value' } }

nsProps.has(obj, 'ns.prop'); // true

nsProps.get(obj, 'ns.prop'); // 'value'
obj.ns.prop; // the same as above, 'value'

nsProps.get(obj, 'hello'); // throws an error, no such property

nsProps.set(obj, 'ns.prop.another', 42); // throws an error, obj.ns.prop can't be a namespace

API

All methods assume that '.' is a "namespace" separator and not a part of a property name when accessing properties.

Objects are tested for inclusion of properties with Object.prototype.hasOwnProperty.

nsProps.has(object, name)

Returns true if there is a "namespaced" property with a name name in object, and false otherwise.

nsProps.get(object, name)

Returns the value of a "namespaced" property name in object.

Throws an error if any part of the "namespace" is missing, including the last (key) part.

nsProps.set(object, name, value)

Sets the value of a "namespaced" property name in object to value. Returns undefined.

Throws an error if any sub-"namespace" is already in object and isn't a "namespace".

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code with npm test.

License

Copyright (c) 2015 FatFisz. Licensed under the MIT license.