added unit testing, and started implementing unit tests...phew
This commit is contained in:
86
node_modules/parse-passwd/README.md
generated
vendored
Normal file
86
node_modules/parse-passwd/README.md
generated
vendored
Normal file
@ -0,0 +1,86 @@
|
||||
# parse-passwd [](https://www.npmjs.com/package/parse-passwd) [](https://npmjs.org/package/parse-passwd) [](https://travis-ci.org/doowb/parse-passwd) [](https://ci.appveyor.com/project/doowb/parse-passwd)
|
||||
|
||||
> Parse a passwd file into a list of users.
|
||||
|
||||
## Install
|
||||
|
||||
Install with [npm](https://www.npmjs.com/):
|
||||
|
||||
```sh
|
||||
$ npm install --save parse-passwd
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
var parse = require('parse-passwd');
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
**Example**
|
||||
|
||||
```js
|
||||
// assuming '/etc/passwd' contains:
|
||||
// doowb:*:123:123:Brian Woodward:/Users/doowb:/bin/bash
|
||||
console.log(parse(fs.readFileSync('/etc/passwd', 'utf8')));
|
||||
|
||||
//=> [
|
||||
//=> {
|
||||
//=> username: 'doowb',
|
||||
//=> password: '*',
|
||||
//=> uid: '123',
|
||||
//=> gid: '123',
|
||||
//=> gecos: 'Brian Woodward',
|
||||
//=> homedir: '/Users/doowb',
|
||||
//=> shell: '/bin/bash'
|
||||
//=> }
|
||||
//=> ]
|
||||
```
|
||||
|
||||
**Params**
|
||||
|
||||
* `content` **{String}**: Content of a passwd file to parse.
|
||||
* `returns` **{Array}**: Array of user objects parsed from the content.
|
||||
|
||||
## About
|
||||
|
||||
### Contributing
|
||||
|
||||
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
|
||||
|
||||
Please read the [contributing guide](contributing.md) for avice on opening issues, pull requests, and coding standards.
|
||||
|
||||
### Building docs
|
||||
|
||||
_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
|
||||
|
||||
To generate the readme and API documentation with [verb](https://github.com/verbose/verb):
|
||||
|
||||
```sh
|
||||
$ npm install -g verb verb-generate-readme && verb
|
||||
```
|
||||
|
||||
### Running tests
|
||||
|
||||
Install dev dependencies:
|
||||
|
||||
```sh
|
||||
$ npm install -d && npm test
|
||||
```
|
||||
|
||||
### Author
|
||||
|
||||
**Brian Woodward**
|
||||
|
||||
* [github/doowb](https://github.com/doowb)
|
||||
* [twitter/doowb](http://twitter.com/doowb)
|
||||
|
||||
### License
|
||||
|
||||
Copyright © 2016, [Brian Woodward](https://github.com/doowb).
|
||||
Released under the [MIT license](LICENSE).
|
||||
|
||||
***
|
||||
|
||||
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on October 19, 2016._
|
Reference in New Issue
Block a user