diff options
author | Minteck <contact@minteck.org> | 2022-06-04 08:51:01 +0200 |
---|---|---|
committer | Minteck <contact@minteck.org> | 2022-06-04 08:51:01 +0200 |
commit | 383285ecd5292bf9a825e05904955b937de84cc9 (patch) | |
tree | 0a53b6f02c1604b078044567c03dc1b6c944c8c2 /node_modules/xdg-basedir/index.d.ts | |
download | equestriadb-383285ecd5292bf9a825e05904955b937de84cc9.tar.gz equestriadb-383285ecd5292bf9a825e05904955b937de84cc9.tar.bz2 equestriadb-383285ecd5292bf9a825e05904955b937de84cc9.zip |
Initial commit
Diffstat (limited to 'node_modules/xdg-basedir/index.d.ts')
-rw-r--r-- | node_modules/xdg-basedir/index.d.ts | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/node_modules/xdg-basedir/index.d.ts b/node_modules/xdg-basedir/index.d.ts new file mode 100644 index 0000000..c70b7d4 --- /dev/null +++ b/node_modules/xdg-basedir/index.d.ts @@ -0,0 +1,81 @@ +declare const xdgBasedir: { + /** + Directory for user-specific data files. + + @example + ```js + import xdgBasedir = require('xdg-basedir'); + + xdgBasedir.data; + //=> '/home/sindresorhus/.local/share' + ``` + */ + readonly data?: string; + + /** + Directory for user-specific configuration files. + + @example + ```js + import xdgBasedir = require('xdg-basedir'); + + xdgBasedir.config; + //=> '/home/sindresorhus/.config' + ``` + */ + readonly config?: string; + + /** + Directory for user-specific non-essential data files. + + @example + ```js + import xdgBasedir = require('xdg-basedir'); + + xdgBasedir.cache; + //=> '/home/sindresorhus/.cache' + ``` + */ + readonly cache?: string; + + /** + Directory for user-specific non-essential runtime files and other file objects (such as sockets, named pipes, etc). + + @example + ```js + import xdgBasedir = require('xdg-basedir'); + + xdgBasedir.runtime; + //=> '/run/user/sindresorhus' + ``` + */ + readonly runtime?: string; + + /** + Preference-ordered array of base directories to search for data files in addition to `.data`. + + @example + ```js + import xdgBasedir = require('xdg-basedir'); + + xdgBasedir.dataDirs + //=> ['/home/sindresorhus/.local/share', '/usr/local/share/', '/usr/share/'] + ``` + */ + readonly dataDirs: readonly string[]; + + /** + Preference-ordered array of base directories to search for configuration files in addition to `.config`. + + @example + ```js + import xdgBasedir = require('xdg-basedir'); + + xdgBasedir.configDirs; + //=> ['/home/sindresorhus/.config', '/etc/xdg'] + ``` + */ + readonly configDirs: readonly string[]; +}; + +export = xdgBasedir; |