1.1.1 • Published 9 years ago
pwuid v1.1.1
pwuid
getpwuid() for Node.js - returns username, name, home directory, shell, gid from
uid
If you're creating a reusable module you should probably use passwd-user instead, as it shells out rather than using a native binding.
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.
Usage
const 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
: usernameuid
: user ID, same as suppliedgid
: group IDgecos
: user information, usually the users full namedir
: home directoryshell
: default shell
Will use current user process.getuid()
if no uid
is supplied.
License
MIT © Sindre Sorhus