username

WebJar for username

License	MIT
GroupId	org.webjars.npm
ArtifactId	username
Last Version	2.3.0
Release Date	Apr 26, 2018
Type	jar
Description	username WebJar for username
Project URL	http://webjars.org
Source Code Management	https://github.com/sindresorhus/username

Download username

Filename	Size
username-2.3.0.pom
username-2.3.0.jar	4 KB
username-2.3.0-sources.jar	22 bytes
username-2.3.0-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/username/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>username</artifactId>
    <version>2.3.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/username/
implementation 'org.webjars.npm:username:2.3.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/username/
implementation ("org.webjars.npm:username:2.3.0")

Apache Buildr

'org.webjars.npm:username:jar:2.3.0'

Apache Ivy

<dependency org="org.webjars.npm" name="username" rev="2.3.0">
  <artifact name="username" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='username', version='2.3.0')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "username" % "2.3.0"

Leiningen

[org.webjars.npm/username "2.3.0"]

Dependencies

compile (2)

Group / Artifact	Type	Version
org.webjars.npm : execa	jar	[0.4.0,0.5)
org.webjars.npm : mem	jar	[0.1.0,0.2)

Project Modules

There are no modules declared in this project.

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

const username = require('username');

(async () => {
	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()

Returns a Promise<string> with the username.

username.sync()

Returns the username.

Related

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

Versions

Version
2.3.0 Apr 26, 2018