🏠 A platform independent path to the user's home.
JavaScript
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
.travis.yml
LICENSE-MIT
README.md
index.js
package.json
test.js

README.md

userhome Build Status

A cross-platform (OSX, Windows, Linux) path to the user's home.

var userhome = require('userhome');

console.log(userhome('.bashrc'));
// /Users/shama/.bashrc

console.log(userhome('test', 'sub', 'file'));
// /Users/shama/test/sub/file

console.log(userhome());
// C:\Users\shama

If a valid user home environment variable could not be found an error will be thrown indicating so.

Release History

  • 1.0.0 - Throws an error if a user home can not be found.
  • 0.1.0 - initial release

License

Copyright (c) 2014 Kyle Robinson Young
Licensed under the MIT license.