History

郭建 6169a71ac2 first commit		2 years ago
..
index.d.ts	first commit	2 years ago
index.js	first commit	2 years ago
license	first commit	2 years ago
package.json	first commit	2 years ago
readme.md	first commit	2 years ago

readme.md

username

Get the username of the current user

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

Install

$ npm install username

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.

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