UNPKG

netrc-parser/README.md

Version:

1.32 kBMarkdownView Raw

1# netrc-parser
2
3[![Greenkeeper badge](https://badges.greenkeeper.io/jdxcode/node-netrc-parser.svg)](https://greenkeeper.io/)
4[![CircleCI](https://circleci.com/gh/jdxcode/node-netrc-parser/tree/master.svg?style=shield)](https://circleci.com/gh/jdxcode/node-netrc-parser/tree/master)
5[![Build status](https://ci.appveyor.com/api/projects/status/vxkkab97cm9lnwb9/branch/master?svg=true)](https://ci.appveyor.com/project/Heroku/node-netrc-parser/branch/master)
6[![codecov](https://codecov.io/gh/jdxcode/node-netrc-parser/branch/master/graph/badge.svg)](https://codecov.io/gh/jdxcode/node-netrc-parser)
7[![npm](https://img.shields.io/npm/v/netrc-parser.svg)](https://npmjs.org/package/netrc-parser)
8[![npm](https://img.shields.io/npm/dw/netrc-parser.svg)](https://npmjs.org/package/netrc-parser)
9[![npm](https://img.shields.io/npm/l/netrc-parser.svg)](https://github.com/jdxcode/node-netrc-parser/blob/master/package.json)
10[![David](https://img.shields.io/david/jdxcode/node-netrc-parser.svg)](https://david-dm.org/jdxcode/node-netrc-parser)
11
12# API
13
14## Netrc
15
16parses a netrc file
17
18**Examples**
19
20```javascript
21const netrc = require('netrc-parser').default
22netrc.loadSync() // or netrc.load() for async
23netrc.machines['api.heroku.com'].password // get auth token from ~/.netrc
24netrc.saveSync() // or netrc.save() for async
25```

1	`# netrc-parser`
2
3	`[![Greenkeeper badge](https://badges.greenkeeper.io/jdxcode/node-netrc-parser.svg)](https://greenkeeper.io/)`
4	`[![CircleCI](https://circleci.com/gh/jdxcode/node-netrc-parser/tree/master.svg?style=shield)](https://circleci.com/gh/jdxcode/node-netrc-parser/tree/master)`
5	`[![Build status](https://ci.appveyor.com/api/projects/status/vxkkab97cm9lnwb9/branch/master?svg=true)](https://ci.appveyor.com/project/Heroku/node-netrc-parser/branch/master)`
6	`[![codecov](https://codecov.io/gh/jdxcode/node-netrc-parser/branch/master/graph/badge.svg)](https://codecov.io/gh/jdxcode/node-netrc-parser)`
7	`[![npm](https://img.shields.io/npm/v/netrc-parser.svg)](https://npmjs.org/package/netrc-parser)`
8	`[![npm](https://img.shields.io/npm/dw/netrc-parser.svg)](https://npmjs.org/package/netrc-parser)`
9	`[![npm](https://img.shields.io/npm/l/netrc-parser.svg)](https://github.com/jdxcode/node-netrc-parser/blob/master/package.json)`
10	`[![David](https://img.shields.io/david/jdxcode/node-netrc-parser.svg)](https://david-dm.org/jdxcode/node-netrc-parser)`
11
12	`# API`
13
14	`## Netrc`
15
16	`parses a netrc file`
17
18	`Examples`
19
20	```javascript
21	`const netrc = require('netrc-parser').default`
22	`netrc.loadSync() // or netrc.load() for async`
23	`netrc.machines['api.heroku.com'].password // get auth token from ~/.netrc`
24	`netrc.saveSync() // or netrc.save() for async`
25	```