@stdlib/os-homedir

Return the current user's home directory.

Usage no npm install needed!

<script type="module">
  import stdlibOsHomedir from 'https://cdn.skypack.dev/@stdlib/os-homedir';
</script>

README

homedir

NPM version Build Status Coverage Status dependencies

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

Examples

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

console.log( homedir() );

CLI

Installation

To use the module as a general utility, install the module globally

npm install -g @stdlib/os-homedir

Usage

Usage: homedir [options]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ homedir
e.g., /Users/<username>

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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.