| Dir : /proc/self/root/opt/alt/alt-nodejs10/root/lib/node_modules/npm/node_modules/libnpmconfig/ |
| Server: Linux ngx353.inmotionhosting.com 4.18.0-553.22.1.lve.1.el8.x86_64 #1 SMP Tue Oct 8 15:52:54 UTC 2024 x86_64 IP: 209.182.202.254 |
| Dir : //proc/self/root/opt/alt/alt-nodejs10/root/lib/node_modules/npm/node_modules/libnpmconfig/README.md |
# libnpmconfig [](https://npm.im/libnpmconfig) [](https://npm.im/libnpmconfig) [](https://travis-ci.org/npm/libnpmconfig) [](https://ci.appveyor.com/project/zkat/libnpmconfig) [](https://coveralls.io/github/npm/libnpmconfig?branch=latest)
[`libnpmconfig`](https://github.com/npm/libnpmconfig) is a Node.js library for
programmatically managing npm's configuration files and data.
## Example
```js
const config = require('libnpmconfig')
console.log('configured registry:', config.read({
registry: 'https://default.registry/'
}))
// => configured registry: https://registry.npmjs.org
```
## Install
`$ npm install libnpmconfig`
## Table of Contents
* [Example](#example)
* [Install](#install)
* [API](#api)
### API
##### <a name="read"></a> `> read(cliOpts, builtinOpts)`
Reads configurations from the filesystem and the env and returns a
[`figgy-pudding`](https://npm.im/figgy-pudding) object with the configuration
values.
If `cliOpts` is provided, it will be merged with the returned config pudding,
shadowing any read values. These are intended as CLI-provided options. Do your
own `process.argv` parsing, though.
If `builtinOpts.cwd` is provided, it will be used instead of `process.cwd()` as
the starting point for config searching.