homedir

Return the current user's home directory.

Installation

npm install @stdlib/os-homedir

Usage

var homedir = require( '@stdlib/os-homedir' );

homedir()

Returns the current user's home directory.

var home = homedir();
// e.g., returns '/Users/<username>'

If unable to locate a home directory, the function returns null.

Notes

• The implementation primarily checks various environment variables to locate a home directory. Note that this approach has security vulnerabilities, as attackers can tamper with environment variables.

Examples

var homedir = require( '@stdlib/os-homedir' );

console.log( homedir() );

See Also

• @stdlib/os-homedir-cli: CLI package for use as a command-line utility.
• @stdlib/os-configdir: return a directory for user-specific configuration files.
• @stdlib/os-tmpdir: return the directory for storing temporary files.

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.