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

7.0.0 • Public • Published

username

Get the username of the current user

This module is meant for informational purposes and not for secure identification.

Install

npm install username

This package only works in Node.js, not in browsers.

Usage

import {username} from 'username';

console.log(await username());
//=> 'sindresorhus'

API

It first tries to get the username from the SUDO_USER LOGNAME USER LNAME USERNAME environment variables. Then falls back to $ id -un on macOS / Linux and $ whoami on Windows, in the rare case none of the environment variables are set. The result is cached.

username(): Promise<string | undefined>

Returns the username.

usernameSync(): string | undefined

Returns the username.

Package Sidebar

Install

npm i username

Weekly Downloads

174,262

Version

7.0.0

License

MIT

Unpacked Size

5.95 kB

Total Files

5

Last publish

Collaborators

  • sindresorhus