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

general-hammond

v2.1.1

Published

read, configure and enforce a configuration file.

Downloads

72

Readme

General Hammond

Reads your cascading service config file, enforces its content, and hands it to you for immediate utilisation. You have a go.

Lieutenant General George Hammond

install

npm i general-Hammond

hammond([domain], [keys])

  • domain - the domain of the config to use (optional, no default) - see cascading service config for more info
  • keys - required keys in the config. see assert keys for more info. this is run after the config is parsed as a CSC.

returns a function that takes one argument, a callback. the callback is passed a single argument, the config. If the config is not found or the fails to parse, an error is thrown (it's assumed that you want the process to terminate at that point)

example

require('general-hammond')('api-server', ['port'])(function(config) {
  // at this point it is guaranteed that the config was found and had a `port`
  // property set under the `api server` domain.
  http.createServer().listen(config.port);
});

how to specify a config

General Hammond will look in several places for the config:

  1. As a file or URL described by the --config command-line argument.
  2. As a file, URL or JSON string described by the "CONFIG" environment variable.
  3. As an object (not a JSON string, pre-CSC parsing), at global.config—this is most useful for supplying a configuration during testing, or other use cases the involve requiring the module the needs configuration.

config overrides

You can override settings in the config by specifying the GH_CONFIG_OVERRIDE environment variable. The value should be a stringified JSON object with values that override those in the config. The values are overlayed by using deep-extend.

For example, given config.json {"service": {"port": 2345, "name": "service!"}}:

export GH_CONFIG_OVERRIDE='{"service":{"port":5678}}'
node service --config config.json

The service receives this config: {"service": {"port": 5678, "name": "service!"}}