Neapolitan Pizza Margherita

    passwd-user
    TypeScript icon, indicating that this package has built-in type declarations

    4.0.0 • Public • Published

    passwd-user

    Get the passwd user entry from a username or user identifier (UID)

    Works on macOS and Linux. See user-info if you need cross-platform support.

    Install

    npm install passwd-user

    Usage

    import {passwdUser} from 'passwd-user';
    
    console.log(await passwdUser('sindresorhus'));
    /*
    {
    	username: 'sindresorhus',
    	password: '*',
    	userIdentifier: 501,
    	groupIdentifier: 20,
    	fullName: 'Sindre Sorhus',
    	homeDirectory: '/home/sindresorhus',
    	shell: '/bin/zsh'
    }
    */
    
    await passwdUser(501);
    console.log('Got entry for user 501');
    
    const user = await passwdUser();
    console.log(`Got entry for user ${user.userIdentifier}`);

    API

    Returns an object with:

    • username
    • password
    • userIdentifier: UID
    • groupIdentifier: GID
    • fullName: Name of user
    • homeDirectory: Home directory
    • shell: Default shell

    passwdUser(username?)

    passwdUser(userIdentifier?)

    Returns a Promise<object> with the user entry.

    passwdUserSync(username?)

    passwdUserSync(userIdentifier?)

    Returns an object with the user entry.

    username

    Type: string

    The username to look up.

    userIdentifier

    Type: number
    Default: process.getuid() (The current user)

    The user identifier (UID) to look up.

    Related

    • username - Get the user's username (cross-platform)
    • fullname - Get the user's fullname (cross-platform)

    Install

    npm i passwd-user

    DownloadsWeekly Downloads

    126,268

    Version

    4.0.0

    License

    MIT

    Unpacked Size

    9.08 kB

    Total Files

    5

    Last publish

    Collaborators

    • sindresorhus