pwuid

getpwuid() binding - returns username, name, home directory, shell, gid from uid

npm install pwuid
2 downloads in the last week
4 downloads in the last month

pwuid Build Status

getpwuid() for Node.js - returns username, name, home directory, shell, gid from uid

Install

npm install --save pwuid

This is a native binding and expects you to have the required toolchain. (ignore the node-gyp install)

Windows

getpwuid() is a POSIX function and won't work on Windows.

Use optionalDependencies if you need to include it in a cross-platform environment.

Example

var pwuid = require('pwuid');
console.log(pwuid());
/*
{
    name: 'sindresorhus',
    uid: 501,
    gid: 20,
    gecos: 'Sindre Sorhus',
    dir: '/Users/sindresorhus',
    shell: '/bin/zsh'
}
*/

API

Accepts a uid number and returns an object with:

  • name: username
  • uid: user ID, same as supplied
  • gid: group ID
  • gecos: user information, usually the users full name
  • dir: home directory
  • shell: default shell

Will use current user process.getuid() if no uid is supplied.

License

MIT © Sindre Sorhus

npm loves you