# xdg-user-dir

> [![CircleCI](https://circleci.com/gh/jskalama/xdg-user-dir.svg?style=svg)](https://circleci.com/gh/jskalama/xdg-user-dir)

Latest version **0.0.1** (published 2018-05-29) · ISC license · 0 weekly downloads

## Install

```sh
npm install xdg-user-dir
pnpm add xdg-user-dir
yarn add xdg-user-dir
bun add xdg-user-dir
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2018-05-29 |
| First published | 2018-05-29 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | corporateanon |

## Links

- npm: https://www.npmjs.com/package/xdg-user-dir
- npm.io page: https://npm.io/package/xdg-user-dir

## Recent versions

- 0.0.1 (latest) — 2018-05-29

## README

[![CircleCI](https://circleci.com/gh/jskalama/xdg-user-dir.svg?style=svg)](https://circleci.com/gh/jskalama/xdg-user-dir)

# xdg-user-dir

Get a list of known shell folders indexed by `XDG_*_DIR` constants.

Usage example:

```javascript
const getXdgUserDirs = require('xdg-user-dir');

getXdgUserDirs().then(folders => {
    console.log(folders);
});
```

Output will look like:

```
{ XDG_DESKTOP_DIR: '/home/user/Рабочий стол',
  XDG_DOWNLOAD_DIR: '/home/user/Загрузки',
  XDG_TEMPLATES_DIR: '/home/user/Шаблоны',
  XDG_PUBLICSHARE_DIR: '/home/user/Общедоступные',
  XDG_DOCUMENTS_DIR: '/home/user/Документы',
  XDG_MUSIC_DIR: '/home/user/Музыка',
  XDG_PICTURES_DIR: '/home/user/Изображения',
  XDG_VIDEOS_DIR: '/home/user/Видео' }
```

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