Permalink
Fetching contributors…
Cannot retrieve contributors at this time
42 lines (32 sloc) 1.41 KB

npmconf

THIS PACKAGE IS DEPRECATED

This package's functionality has been reintegrated directly into npm. There have been many changes made to npm's configuration since the last version of this package was published. It should not be considered a source of truth for npm configuration any longer, and npm itself is the best tool to use to manage its configuration. Do not use this package.

The config thing npm uses

If you are interested in interacting with the config settings that npm uses, then use this module.

However, if you are writing a new Node.js program, and want configuration functionality similar to what npm has, but for your own thing, then I'd recommend using rc, which is probably what you want.

If I were to do it all over again, that's what I'd do for npm. But, alas, there are many systems depending on many of the particulars of npm's configuration setup, so it's not worth the cost of changing.

USAGE

var npmconf = require('npmconf')

// pass in the cli options that you read from the cli
// or whatever top-level configs you want npm to use for now.
npmconf.load({some:'configs'}, function (er, conf) {
  // do stuff with conf
  conf.get('some', 'cli') // 'configs'
  conf.get('username') // 'joebobwhatevers'
  conf.set('foo', 'bar', 'user')
  conf.save('user', function (er) {
    // foo = bar is now saved to ~/.npmrc or wherever
  })
})