https://github.com/martinheidegger/os-user

The currently logged-in user. Calls whoami if not found.
https://github.com/martinheidegger/os-user

Last synced: about 4 hours ago
JSON representation

The currently logged-in user. Calls whoami if not found.

• Host: GitHub
• URL: https://github.com/martinheidegger/os-user
• Owner: martinheidegger
• License: other
• Created: 2015-12-06T15:41:50.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-04-14T17:20:39.000Z (over 7 years ago)
• Last Synced: 2024-09-07T06:25:04.811Z (26 days ago)
• Language: JavaScript
• Size: 21.5 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 46
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# os-user [![Build Status](https://travis-ci.org/martinheidegger/os-user.svg?branch=master)](https://travis-ci.org/martinheidegger/os-user)

Simple [node.js](https://nodejs.org/) util that returns the user currently running on the system.

On windows this util is aware of the domain using the `USERDOMAIN` and `USERNAME` variable.

On other systems it uses the `USER` environment variable. If the `USER` is not given or empty on other systems it will fallback to `whoami`.

# Usage 

Install with:

```

$ npm i os-user --save

```

and use it with:

```JavaScript

var user = require('os-user')

user(function (err, usr) {

    console.log(usr)

})

```

cheers.

## Caching & Invalidation

By default the user is cached for 10 minutes it is possible to invalidate the cache using:

```JavaScript

user.invalidate()

```

## License

[ISC](https://en.wikipedia.org/wiki/ISC_license)

first version extracted from [osenv](https://github.com/npm/osenv)