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

modular-configuration

v0.0.3

Published

A minimalistic configuration manager made The Node Way (TM)

Downloads

26

Readme

Modular Configuration

A minimalistic configuration manager made The Node Way ™.

Goals

Other configuration modules failed to provide a few preferred features. This module aims to provide:

  • environment variable, command line, overrides
  • load from any directory, from a list of directories (with fallbacks)
  • accept raw JSON objects
  • have strict mode(s)
  • have dot notation getters(/setters) (dot notation module)
  • setters not necessary but helpful (per instance)
  • read standard JSON, but also .JS (for dynamic fields?)
  • synchronous and asynchronous support, with promises
  • be hotloadable
  • allow configuration overlaying
  • be modular and function independently of other configuration objects
  • allow configuration nesting and access via chaining
  • allow configurations to be set, deleted, and saved
  • allow configuration locking/immutability so that changes are prevented
  • source tracking for debugging purposes
  • option to use package.json
  • browser support

API

Contents of ./config.json:

{
    "Name": "John",
    "Values": [ 1, 2, 3, 9, 7, 8 ],
    "Object": {
        "Name": "Jake",
        "Values": [ 100, 200, 300 ]
    },
    "Boolean": true,
    "Float": 0.01,
    "Redirect": {
        "Home": {
            "Address": "https://example.com/",
            "Visitors": 87
        }
    }
}

Contents of ./alternate.json:

{
    "Name": "Elizabeth"
}

Example usage:

const Config = require('modular-configuration');

const config = new Config();
const path = require('path');

config.setStrict(true);

config.load(path.join(__dirname, '/config.json'))
  .then(() => {
    console.log(config.get('Name')); // -> John
    console.log(config.get('Values')); // -> [ 1, 2, 3, 9, 7, 8 ]
    console.log(config.get('Redirect.Home.Address')); // -> https://example.com/
    console.log(config.set('Name', 'Nick'));
    console.log(config.get('Name')); // -> Nick

    const alternate = new Config();

    // Alternative loading method
    alternate.load('./alternate.json')
      .then(() => {
        console.log(config.get('Name')); // -> Elizabeth
      })
      .catch((err) => {
        console.error(err);
      });

    const subConfig = new Config();
    subConfig.loadSync(config.get('Object'));
    console.log(subConfig.get('Name')); // -> Jake
    console.log(subConfig.get('Values')); // -> [ 100, 200, 300 ]
  })
  .then(() => {
    console.log(config.get('Unknown')); // Should crash
  })
  .catch((err) => {
    console.error(err);
  });