Git Product home page Git Product logo

pwuid's Introduction

pwuid Build Status

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: 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

pwuid's People

Contributors

sindresorhus avatar mmalecki avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.