time-to-botec/squiggle/node_modules/@stdlib/os/homedir/docs/repl.txt
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

20 lines
316 B
Plaintext

{{alias}}()
Returns the current user's home directory.
If unable to locate a home directory, the function returns `null`.
Returns
-------
out: string|null
Home directory.
Examples
--------
> var home = {{alias}}()
e.g., '/Users/<username>'
See Also
--------