Socket
Socket
Sign inDemoInstall

username

Package Overview
Dependencies
18
Maintainers
1
Versions
17
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    username

Get the username of the current user


Version published
Weekly downloads
174K
increased by2.01%
Maintainers
1
Install size
325 kB
Created
Weekly downloads
 

Readme

Source

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.

  • username-cli - CLI for this module
  • fullname - Get the fullname of the current user

Keywords

FAQs

Last updated on 14 Nov 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc