diff options
Diffstat (limited to 'os/README.md')
| -rw-r--r-- | os/README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/os/README.md b/os/README.md new file mode 100644 index 000000000..0f2ea810b --- /dev/null +++ b/os/README.md @@ -0,0 +1,16 @@ +# os + +Module provide platform-independent interface to operating system functionality. + +## Usage + +### userHomeDir + +Returns the current user's home directory. On Unix, including macOS, it returns the \$HOME environment variable. On Windows, it returns %USERPROFILE%. +Needs permissions to access env (--allow-env). + +```ts +import { userHomeDir } from "https://deno.land/std/os/mod.ts"; + +userHomeDir(); +``` |
