Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/justjavac/deno_data_dir

Returns the path to the user's data directory.
https://github.com/justjavac/deno_data_dir

data deno deno-module deno-modules directory

Last synced: 15 days ago
JSON representation

Returns the path to the user's data directory.

Awesome Lists containing this project

README

        

# deno_data_dir

[![tag](https://img.shields.io/github/release/justjavac/deno_data_dir)](https://github.com/justjavac/deno_data_dir/releases)
[![Build Status](https://github.com/justjavac/deno_data_dir/workflows/ci/badge.svg?branch=master)](https://github.com/justjavac/deno_data_dir/actions)
[![license](https://img.shields.io/github/license/justjavac/deno_data_dir)](https://github.com/justjavac/deno_data_dir/blob/master/LICENSE)

> _In v1.1.2(2020.06.26), Deno
> [Remove `Deno.dir` and dirs dependency #6385](https://github.com/denoland/deno/pull/6385)_

Returns the path to the user's data 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_DATA_HOME` or `$HOME`/.local/share | /home/justjavac/.local/share |
| macOS | `$HOME`/Library/Application Support | /Users/justjavac/Library/Application Support |
| Windows | `$APPDATA` | C:\Users\justjavac\AppData\Roaming |

## Usage

Requires `allow-env` permission.

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

```ts
import dataDir from "https://deno.land/x/data_dir/mod.ts";

dataDir();
// Lin: "/home/justjavac/.local/share"
// Mac: "/Users/justjavac/Library/Application Support"
// Win: "C:\Users\justjavac\AppData\Roaming"
```

## License

[deno_data_dir](https://github.com/justjavac/deno_data_dir) is released under
the MIT License. See the bundled [LICENSE](./LICENSE) file for details.