CityBEM-CityLayers-SaeedRay.../node_modules/username
2024-11-05 15:01:14 -05:00
..
index.d.ts This commit pushes the node_modules folder separately due to its large size. 2024-11-05 15:01:14 -05:00
index.js This commit pushes the node_modules folder separately due to its large size. 2024-11-05 15:01:14 -05:00
license This commit pushes the node_modules folder separately due to its large size. 2024-11-05 15:01:14 -05:00
package.json This commit pushes the node_modules folder separately due to its large size. 2024-11-05 15:01:14 -05:00
readme.md This commit pushes the node_modules folder separately due to its large size. 2024-11-05 15:01:14 -05:00

username Build Status

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.

License

MIT © Sindre Sorhus