summaryrefslogtreecommitdiff
path: root/node_modules/env-paths/readme.md
diff options
context:
space:
mode:
authorLinuxWizard42 <computerwizard@linuxmail.org>2022-10-12 22:54:37 +0300
committerLinuxWizard42 <computerwizard@linuxmail.org>2022-10-12 22:54:37 +0300
commit703e03aba33f234712206769f57717ba7d92d23d (patch)
tree0041f04ccb75bd5379c764e9fe42249fffe75fc3 /node_modules/env-paths/readme.md
parentab6e257e6e9d9a483d7e86f220d8b209a2cd7753 (diff)
downloadFlashRunner-703e03aba33f234712206769f57717ba7d92d23d.tar.gz
FlashRunner-703e03aba33f234712206769f57717ba7d92d23d.tar.zst
Added export_allowed file to make repository visible in cgit
Diffstat (limited to 'node_modules/env-paths/readme.md')
-rw-r--r--node_modules/env-paths/readme.md71
1 files changed, 71 insertions, 0 deletions
diff --git a/node_modules/env-paths/readme.md b/node_modules/env-paths/readme.md
new file mode 100644
index 0000000..0bdc2ac
--- /dev/null
+++ b/node_modules/env-paths/readme.md
@@ -0,0 +1,71 @@
+# env-paths [![Build Status](https://travis-ci.org/sindresorhus/env-paths.svg?branch=master)](https://travis-ci.org/sindresorhus/env-paths)
+
+> Get paths for storing things like data, config, cache, etc
+
+
+## Install
+
+```
+$ npm install --save env-paths
+```
+
+
+## Usage
+
+```js
+const envPaths = require('env-paths');
+const paths = envPaths('MyApp');
+
+paths.data;
+//=> '/home/sindresorhus/.local/share/MyApp-nodejs'
+
+paths.config
+//=> '/home/sindresorhus/.config/MyApp-nodejs'
+```
+
+
+## API
+
+### paths = envPaths(name, [options])
+
+#### name
+
+Type: `string`
+
+Name of your project. Used to generate the paths.
+
+#### options
+
+##### suffix
+
+Type: `string`<br>
+Default: `'nodejs'`
+
+**Don't use this option unless you really have to!**<br>
+Suffix appended to the project name to avoid name conflicts with native
+apps. Pass an empty string to disable it.
+
+### paths.data
+
+Directory for data files.
+
+### paths.config
+
+Directory for config files.
+
+### paths.cache
+
+Directory for non-essential data files.
+
+### paths.log
+
+Directory for log files.
+
+### paths.temp
+
+Directory for temporary files.
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)