49 lines
1.1 KiB
Markdown
49 lines
1.1 KiB
Markdown
|
# username [](https://travis-ci.org/sindresorhus/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
|
||
|
|
|
||
|
|
```js
|
||
|
|
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](https://github.com/sindresorhus/username-cli) - CLI for this module
|
||
|
|
- [fullname](https://github.com/sindresorhus/fullname) - Get the fullname of the current user
|
||
|
|
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
MIT © [Sindre Sorhus](https://sindresorhus.com)
|