time-to-botec/squiggle/node_modules/@stdlib/os/homedir
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00
..
bin feat: add the node modules 2022-12-03 12:44:49 +00:00
docs feat: add the node modules 2022-12-03 12:44:49 +00:00
etc feat: add the node modules 2022-12-03 12:44:49 +00:00
lib feat: add the node modules 2022-12-03 12:44:49 +00:00
package.json feat: add the node modules 2022-12-03 12:44:49 +00:00
README.md feat: add the node modules 2022-12-03 12:44:49 +00:00

homedir

Return the current user's home directory.

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

Usage

Usage: homedir [options]

Options:

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

Examples

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