node_modules/parse-passwd/README.md

In thisisnic/starrating: What the Package Does (One Line, Title Case)

parse-passwd

Parse a passwd file into a list of users.

Install

Install with npm:

$ npm install --save parse-passwd

Usage

var parse = require('parse-passwd');

API

Example

// 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.

Please read the contributing guide for avice on opening issues, pull requests, and coding standards.

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Brian Woodward

• github/doowb
• twitter/doowb

License

Copyright © 2016, Brian Woodward. Released under the MIT license.

This file was generated by verb-generate-readme, v0.2.0, on October 19, 2016.

thisisnic/starrating documentation built on May 18, 2019, 1:32 p.m.