# @xan105/usershellfolder

> User shell folders

Latest version **1.2.1** (published 2023-12-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @xan105/usershellfolder
pnpm add @xan105/usershellfolder
yarn add @xan105/usershellfolder
bun add @xan105/usershellfolder
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities; has provenance.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2023-12-05 |
| First published | 2021-05-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Node | >=18.0.0 |
| Dependencies | 0 |
| Unpacked size | 7.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 0 |
| Author | Anthony Beaumont |
| Maintainers | xan105 |
| Keywords | userShellFolder, shell, folder, windows, linux, registry, xdg, env |

## Links

- npm: https://www.npmjs.com/package/@xan105/usershellfolder
- Repository: https://github.com/xan105/node-usershellfolder
- Homepage: https://github.com/xan105/node-usershellfolder#readme
- Issues: https://github.com/xan105/node-usershellfolder/issues
- Funding: https://github.com/sponsors/xan105
- npm.io page: https://npm.io/package/@xan105/usershellfolder

## Alternatives

- [replicas-cli](https://npm.io/package/replicas-cli.md) — 3.0K weekly downloads
- [env-contract](https://npm.io/package/env-contract.md) — 133 weekly downloads
- [@openveo/api](https://npm.io/package/@openveo/api.md) — 61 weekly downloads
- [@ryniaubenpm2/cumque-error-reiciendis](https://npm.io/package/@ryniaubenpm2/cumque-error-reiciendis.md) — 54 weekly downloads
- [ts-global-type-extra](https://npm.io/package/ts-global-type-extra.md) — 11 weekly downloads

## Recent versions

- 1.2.1 (latest) — 2023-12-05
- 1.2.0 — 2023-12-05
- 1.1.4 — 2023-03-20
- 1.1.3 — 2023-02-23
- 1.1.2 — 2023-02-14
- 1.1.1 — 2022-03-23
- 1.1.0 — 2022-03-21
- 1.0.2 — 2021-09-22
- 1.0.0 — 2021-05-11

## README

About
=====

User shell folders.

Example
=======

```js
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
===

⚠️ This module is only available as an ECMAScript module (ESM).

## Named export

### `const folders = object`

#### Windows

On Windows return an object as the following:

```js
{
  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:

```js
{
  root: ...,
  temp: ...,
  user: {
    data: ...,
    config: ...,
    cache: ...,
    home: ...,
    desktop: ...,
    documents: ...,
    music: ...,
    pictures: ...,
    videos: ...,
    download: ... 
  }
}
```

## Default export

Alias to `const folders` for backward compatibility

---
_Source: https://npm.io/package/@xan105/usershellfolder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._