About
User shell folders.
Example
import { folders } from "@xan105/usershellfolder";
const path = folders.user.desktop;
console.log(path);
//Win: C:\Users\Xan\Desktop
//Linux: /home/Xan/Desktop
Install
npm install @xan105/usershellfolder
API
Named export
const folders = object
Windows
On Windows return an object as the following:
{
root: ...,
temp: ...,
user: {
appData: ...,
localAppData: ...,
home: ...,
desktop: ...,
documents: ...,
music: ...,
pictures: ...,
videos: ...,
download: ...,
savegame: ...
},
common: {
appData: ...,
home: ...,
desktop: ...,
documents: ...,
music: ...,
pictures: ...,
videos: ...
}
}
Linux
On Linux return an object as the following:
{
root: ...,
temp: ...,
user: {
data: ...,
config: ...,
cache: ...,
home: ...,
desktop: ...,
documents: ...,
music: ...,
pictures: ...,
videos: ...,
download: ...
}
}
Default export
Alias to const folders
for backward compatibility