Skip to content

Returns the path to the user's document directory.

License

Notifications You must be signed in to change notification settings

justjavac/deno_document_dir

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

deno_document_dir

Returns the path to the user's document directory.

The returned value depends on the operating system and is either a string, containing a value from the following table, or null.

Platform Value Example
Linux XDG_DOCUMENTS_DIR /home/justjavac/Documents
macOS $HOME/Documents /Users/justjavac/Documents
Windows $USERPROFILE/Documents C:\Users\justjavac\Documents

Usage

Requires allow-env permission.

Returns null if there is no applicable directory or if any other error occurs.

import documentDir from "https://deno.land/x/document_dir/mod.ts";

documentDir();
// Lin: "/home/justjavac/Documents"
// Mac: "/Users/justjavac/Documents"
// Win: "C:\Users\justjavac\Documents"

License

deno_document_dir is released under the MIT License. See the bundled LICENSE file for details.