platformdirs 4.3.7 → 4.3.8-rc2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +80 -6
- package/dist/android.d.ts +19 -20
- package/dist/android.js +22 -23
- package/dist/api.d.ts +43 -47
- package/dist/api.js +28 -31
- package/dist/configparser.d.ts +5 -0
- package/dist/configparser.js +53 -0
- package/dist/index.d.ts +27 -29
- package/dist/index.js +26 -22
- package/dist/macos.d.ts +1 -1
- package/dist/macos.js +10 -13
- package/dist/main.d.ts +5 -0
- package/dist/main.js +5 -0
- package/dist/unix.d.ts +8 -4
- package/dist/unix.js +28 -22
- package/dist/version.d.ts +1 -1
- package/dist/version.js +9 -23
- package/dist/windows.d.ts +1 -1
- package/package.json +9 -10
package/README.md
CHANGED
|
@@ -4,8 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
<table align=center><td>
|
|
6
6
|
|
|
7
|
-
<div><sub><i>Running on Linux</i></sub></div>
|
|
8
|
-
|
|
9
7
|
```js
|
|
10
8
|
const dirs = new PlatformDirs("awesome-app", "octocat", "1.2")
|
|
11
9
|
console.log(dirs.userDataDir)
|
|
@@ -22,7 +20,7 @@ console.log(userLogDir("my-app", "gopher", "7.8"))
|
|
|
22
20
|
</table>
|
|
23
21
|
|
|
24
22
|
<p align=center>
|
|
25
|
-
<a href="https://
|
|
23
|
+
<a href="https://tsdocs.dev/docs/platformdirs">Documentation</a>
|
|
26
24
|
| <a href="https://pypi.org/project/platformdirs/">Original <code>platformdirs</code> project</a>
|
|
27
25
|
</p>
|
|
28
26
|
|
|
@@ -33,6 +31,9 @@ console.log(userLogDir("my-app", "gopher", "7.8"))
|
|
|
33
31
|
## Installation
|
|
34
32
|
|
|
35
33
|
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
36
37
|
|
|
37
38
|
You can install this package from [the npm registry](https://www.npmjs.com/) using npm, Yarn, pnpm, Bun, Deno, etc.
|
|
38
39
|
|
|
@@ -40,6 +41,8 @@ You can install this package from [the npm registry](https://www.npmjs.com/) usi
|
|
|
40
41
|
npm install platformdirs
|
|
41
42
|
```
|
|
42
43
|
|
|
44
|
+
This package works with Node.js, Deno, and Bun. It is not intended to be used in the browser.
|
|
45
|
+
|
|
43
46
|
## Usage
|
|
44
47
|
|
|
45
48
|
|
|
@@ -64,7 +67,7 @@ if (!fs.existsSync(bigCSVPath)) {
|
|
|
64
67
|
}
|
|
65
68
|
```
|
|
66
69
|
|
|
67
|
-
📚 For more information check out [the documentation](https://
|
|
70
|
+
📚 For more information check out [the documentation](https://tsdocs.dev/docs/platformdirs)
|
|
68
71
|
|
|
69
72
|
You can quickly dump all the directories for the current environment by running the included `platformdirs` CLI command. This is helpful for quickly determining what `dirs.userConfigDir` and friends return.
|
|
70
73
|
|
|
@@ -75,7 +78,74 @@ npx platformdirs
|
|
|
75
78
|
<details><summary>Output on Windows</summary>
|
|
76
79
|
|
|
77
80
|
```
|
|
78
|
-
|
|
81
|
+
-- platformdirs 4.3.7 --
|
|
82
|
+
-- app dirs (with optional 'version')
|
|
83
|
+
user_data_dir: C:\Users\me\AppData\Local\MyCompany\MyApp\1.0
|
|
84
|
+
user_config_dir: C:\Users\me\AppData\Local\MyCompany\MyApp\1.0
|
|
85
|
+
user_cache_dir: C:\Users\me\AppData\Local\MyCompany\MyApp\Cache\1.0
|
|
86
|
+
user_state_dir: C:\Users\me\AppData\Local\MyCompany\MyApp\1.0
|
|
87
|
+
user_log_dir: C:\Users\me\AppData\Local\MyCompany\MyApp\1.0\Logs
|
|
88
|
+
user_documents_dir: C:\Users\me\Documents
|
|
89
|
+
user_downloads_dir: C:\Users\me\Downloads
|
|
90
|
+
user_pictures_dir: C:\Users\me\Pictures
|
|
91
|
+
user_videos_dir: C:\Users\me\Videos
|
|
92
|
+
user_music_dir: C:\Users\me\Music
|
|
93
|
+
user_runtime_dir: C:\Users\me\AppData\Local\Temp\MyCompany\MyApp\1.0
|
|
94
|
+
site_data_dir: C:\ProgramData\MyCompany\MyApp\1.0
|
|
95
|
+
site_config_dir: C:\ProgramData\MyCompany\MyApp\1.0
|
|
96
|
+
site_cache_dir: C:\ProgramData\MyCompany\MyApp\Cache\1.0
|
|
97
|
+
site_runtime_dir: C:\Users\me\AppData\Local\Temp\MyCompany\MyApp\1.0
|
|
98
|
+
|
|
99
|
+
-- app dirs (without optional 'version')
|
|
100
|
+
user_data_dir: C:\Users\me\AppData\Local\MyCompany\MyApp
|
|
101
|
+
user_config_dir: C:\Users\me\AppData\Local\MyCompany\MyApp
|
|
102
|
+
user_cache_dir: C:\Users\me\AppData\Local\MyCompany\MyApp\Cache
|
|
103
|
+
user_state_dir: C:\Users\me\AppData\Local\MyCompany\MyApp
|
|
104
|
+
user_log_dir: C:\Users\me\AppData\Local\MyCompany\MyApp\Logs
|
|
105
|
+
user_documents_dir: C:\Users\me\Documents
|
|
106
|
+
user_downloads_dir: C:\Users\me\Downloads
|
|
107
|
+
user_pictures_dir: C:\Users\me\Pictures
|
|
108
|
+
user_videos_dir: C:\Users\me\Videos
|
|
109
|
+
user_music_dir: C:\Users\me\Music
|
|
110
|
+
user_runtime_dir: C:\Users\me\AppData\Local\Temp\MyCompany\MyApp
|
|
111
|
+
site_data_dir: C:\ProgramData\MyCompany\MyApp
|
|
112
|
+
site_config_dir: C:\ProgramData\MyCompany\MyApp
|
|
113
|
+
site_cache_dir: C:\ProgramData\MyCompany\MyApp\Cache
|
|
114
|
+
site_runtime_dir: C:\Users\me\AppData\Local\Temp\MyCompany\MyApp
|
|
115
|
+
|
|
116
|
+
-- app dirs (without optional 'appauthor')
|
|
117
|
+
user_data_dir: C:\Users\me\AppData\Local\MyApp\MyApp
|
|
118
|
+
user_config_dir: C:\Users\me\AppData\Local\MyApp\MyApp
|
|
119
|
+
user_cache_dir: C:\Users\me\AppData\Local\MyApp\MyApp\Cache
|
|
120
|
+
user_state_dir: C:\Users\me\AppData\Local\MyApp\MyApp
|
|
121
|
+
user_log_dir: C:\Users\me\AppData\Local\MyApp\MyApp\Logs
|
|
122
|
+
user_documents_dir: C:\Users\me\Documents
|
|
123
|
+
user_downloads_dir: C:\Users\me\Downloads
|
|
124
|
+
user_pictures_dir: C:\Users\me\Pictures
|
|
125
|
+
user_videos_dir: C:\Users\me\Videos
|
|
126
|
+
user_music_dir: C:\Users\me\Music
|
|
127
|
+
user_runtime_dir: C:\Users\me\AppData\Local\Temp\MyApp\MyApp
|
|
128
|
+
site_data_dir: C:\ProgramData\MyApp\MyApp
|
|
129
|
+
site_config_dir: C:\ProgramData\MyApp\MyApp
|
|
130
|
+
site_cache_dir: C:\ProgramData\MyApp\MyApp\Cache
|
|
131
|
+
site_runtime_dir: C:\Users\me\AppData\Local\Temp\MyApp\MyApp
|
|
132
|
+
|
|
133
|
+
-- app dirs (with disabled 'appauthor')
|
|
134
|
+
user_data_dir: C:\Users\me\AppData\Local\MyApp
|
|
135
|
+
user_config_dir: C:\Users\me\AppData\Local\MyApp
|
|
136
|
+
user_cache_dir: C:\Users\me\AppData\Local\MyApp\Cache
|
|
137
|
+
user_state_dir: C:\Users\me\AppData\Local\MyApp
|
|
138
|
+
user_log_dir: C:\Users\me\AppData\Local\MyApp\Logs
|
|
139
|
+
user_documents_dir: C:\Users\me\Documents
|
|
140
|
+
user_downloads_dir: C:\Users\me\Downloads
|
|
141
|
+
user_pictures_dir: C:\Users\me\Pictures
|
|
142
|
+
user_videos_dir: C:\Users\me\Videos
|
|
143
|
+
user_music_dir: C:\Users\me\Music
|
|
144
|
+
user_runtime_dir: C:\Users\me\AppData\Local\Temp\MyApp
|
|
145
|
+
site_data_dir: C:\ProgramData\MyApp
|
|
146
|
+
site_config_dir: C:\ProgramData\MyApp
|
|
147
|
+
site_cache_dir: C:\ProgramData\MyApp\Cache
|
|
148
|
+
site_runtime_dir: C:\Users\me\AppData\Local\Temp\MyApp
|
|
79
149
|
```
|
|
80
150
|
|
|
81
151
|
</details>
|
|
@@ -169,4 +239,8 @@ site_runtime_dir: /run/MyApp
|
|
|
169
239
|
|
|
170
240
|
|
|
171
241
|
|
|
172
|
-
This project uses Node.js, TypeScript, and
|
|
242
|
+
This project uses Node.js, npm, TypeScript, and [Biome](https://biomejs.dev/) instead of the usual [Prettier](https://prettier.io/) & [ESLint](https://eslint.org/) combo. Why? Because ESLint bungled their v9 release and Biome offers a more cohesive linter & formatter solution.
|
|
243
|
+
|
|
244
|
+
For package releases make sure to always release a `-rc1` version first. If it's 100% OK then proceed to release it as normal. The goal is to keep the npm `platformdirs@X.Y.Z` package in sync with PyPI `platformdirs==X.Y.Z`.
|
|
245
|
+
|
|
246
|
+
So far I have failed at this and now I'm two patch versions _ahead_ of the Python package. Oopsies.
|
package/dist/android.d.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
*
|
|
5
5
|
* TODO: Implement this module.
|
|
6
6
|
*/
|
|
7
|
-
import { PlatformDirsABC } from "./api.
|
|
7
|
+
import { PlatformDirsABC } from "./api.ts";
|
|
8
8
|
/**
|
|
9
9
|
* Follows the guidance [from here](https://android.stackexchange.com/a/216132).
|
|
10
10
|
*
|
|
@@ -12,70 +12,69 @@ import { PlatformDirsABC } from "./api.js";
|
|
|
12
12
|
* {@link PlatformDirsABC.version}, {@link PlatformDirsABC.ensureExists}.
|
|
13
13
|
*/
|
|
14
14
|
export declare class Android extends PlatformDirsABC {
|
|
15
|
-
/**
|
|
16
|
-
* @return data directory tied to the user, e.g. `/data/user/<userid>/<packagename>/files/<AppName>`
|
|
17
|
-
*/
|
|
18
15
|
get userDataDir(): string;
|
|
19
16
|
/**
|
|
20
|
-
*
|
|
17
|
+
* data directory shared by users, same as `userDataDir`
|
|
21
18
|
*/
|
|
22
19
|
get siteDataDir(): string;
|
|
23
20
|
/**
|
|
24
|
-
*
|
|
21
|
+
* config directory tied to the user, e.g. `/data/user/<userid>/<packagename>/shared_prefs/<AppName>`
|
|
25
22
|
*/
|
|
26
23
|
get userConfigDir(): string;
|
|
27
24
|
/**
|
|
28
|
-
*
|
|
25
|
+
* config directory shared by users, same as `userConfigDir`
|
|
29
26
|
*/
|
|
30
27
|
get siteConfigDir(): string;
|
|
31
28
|
/**
|
|
32
|
-
*
|
|
29
|
+
* cache directory tied to the user, e.g. `/data/user/<userid>/<packagename>/cache/<AppName>`
|
|
33
30
|
*/
|
|
34
31
|
get userCacheDir(): string;
|
|
35
32
|
/**
|
|
36
|
-
*
|
|
33
|
+
* cache directory shared by users, same as `userCacheDir`
|
|
37
34
|
*/
|
|
38
35
|
get siteCacheDir(): string;
|
|
39
36
|
/**
|
|
40
|
-
*
|
|
37
|
+
* state directory tied to the user, same as `userDataDir`
|
|
41
38
|
*/
|
|
42
39
|
get userStateDir(): string;
|
|
43
40
|
/**
|
|
44
|
-
*
|
|
41
|
+
* log directory tied to the user, same as `userCacheDir` if not opinionated else `log` in it, e.g. `/data/user/<userid>/<packagename>/cache/<AppName>/log`
|
|
45
42
|
*/
|
|
46
43
|
get userLogDir(): string;
|
|
47
44
|
/**
|
|
48
|
-
*
|
|
45
|
+
* documents directory tied to the user, e.g. `/storage/emulated/0/Documents`
|
|
49
46
|
*/
|
|
50
47
|
get userDocumentsDir(): string;
|
|
51
48
|
/**
|
|
52
|
-
*
|
|
49
|
+
* downloads directory tied to the user, e.g. `/storage/emulated/0/Downloads`
|
|
53
50
|
*/
|
|
54
51
|
get userDownloadsDir(): string;
|
|
55
52
|
/**
|
|
56
|
-
*
|
|
53
|
+
* pictures directory tied to the user, e.g. `/storage/emulated/0/Pictures`
|
|
57
54
|
*/
|
|
58
55
|
get userPicturesDir(): string;
|
|
59
56
|
/**
|
|
60
|
-
*
|
|
57
|
+
* videos directory tied to the user, e.g. `/storage/emulated/0/Movies`
|
|
61
58
|
*/
|
|
62
59
|
get userVideosDir(): string;
|
|
63
60
|
/**
|
|
64
|
-
*
|
|
61
|
+
* music directory tied to the user, e.g. `/storage/emulated/0/Music`
|
|
65
62
|
*/
|
|
66
63
|
get userMusicDir(): string;
|
|
67
64
|
/**
|
|
68
|
-
*
|
|
65
|
+
* desktop directory tied to the user, e.g. `/storage/emulated/0/Desktop`
|
|
69
66
|
*/
|
|
70
67
|
get userDesktopDir(): string;
|
|
71
68
|
/**
|
|
72
|
-
*
|
|
69
|
+
* runtime directory tied to the user, same as `userCacheDir` if not opinionated else `tmp` in it, e.g. `/data/user/<userid>/<packagename>/cache/<AppName>/tmp`
|
|
73
70
|
*/
|
|
74
71
|
get userRuntimeDir(): string;
|
|
75
72
|
/**
|
|
76
|
-
*
|
|
73
|
+
* runtime directory shared by users, same as `userRuntimeDir`
|
|
77
74
|
*/
|
|
78
75
|
get siteRuntimeDir(): string;
|
|
79
76
|
}
|
|
80
|
-
/**
|
|
77
|
+
/**
|
|
78
|
+
* @ignore @internal
|
|
79
|
+
*/
|
|
81
80
|
export declare function _androidFolder(): string | undefined;
|
package/dist/android.js
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
*/
|
|
7
7
|
import * as path from "node:path";
|
|
8
8
|
import { PlatformDirsABC } from "./api.js";
|
|
9
|
-
function
|
|
9
|
+
function throwExpression(error) {
|
|
10
10
|
throw error;
|
|
11
11
|
}
|
|
12
12
|
/**
|
|
@@ -16,50 +16,47 @@ function throw2(error) {
|
|
|
16
16
|
* {@link PlatformDirsABC.version}, {@link PlatformDirsABC.ensureExists}.
|
|
17
17
|
*/
|
|
18
18
|
export class Android extends PlatformDirsABC {
|
|
19
|
-
/**
|
|
20
|
-
* @return data directory tied to the user, e.g. `/data/user/<userid>/<packagename>/files/<AppName>`
|
|
21
|
-
*/
|
|
22
19
|
get userDataDir() {
|
|
23
|
-
return this._appendAppNameAndVersion(_androidFolder() ??
|
|
20
|
+
return this._appendAppNameAndVersion(_androidFolder() ?? throwExpression(new Error("unreachable")), "files");
|
|
24
21
|
}
|
|
25
22
|
/**
|
|
26
|
-
*
|
|
23
|
+
* data directory shared by users, same as `userDataDir`
|
|
27
24
|
*/
|
|
28
25
|
get siteDataDir() {
|
|
29
26
|
return this.userDataDir;
|
|
30
27
|
}
|
|
31
28
|
/**
|
|
32
|
-
*
|
|
29
|
+
* config directory tied to the user, e.g. `/data/user/<userid>/<packagename>/shared_prefs/<AppName>`
|
|
33
30
|
*/
|
|
34
31
|
get userConfigDir() {
|
|
35
|
-
return this._appendAppNameAndVersion(_androidFolder() ??
|
|
32
|
+
return this._appendAppNameAndVersion(_androidFolder() ?? throwExpression(new Error("unreachable")), "shared_prefs");
|
|
36
33
|
}
|
|
37
34
|
/**
|
|
38
|
-
*
|
|
35
|
+
* config directory shared by users, same as `userConfigDir`
|
|
39
36
|
*/
|
|
40
37
|
get siteConfigDir() {
|
|
41
38
|
return this.userConfigDir;
|
|
42
39
|
}
|
|
43
40
|
/**
|
|
44
|
-
*
|
|
41
|
+
* cache directory tied to the user, e.g. `/data/user/<userid>/<packagename>/cache/<AppName>`
|
|
45
42
|
*/
|
|
46
43
|
get userCacheDir() {
|
|
47
|
-
return this._appendAppNameAndVersion(_androidFolder() ??
|
|
44
|
+
return this._appendAppNameAndVersion(_androidFolder() ?? throwExpression(new Error("unreachable")), "cache");
|
|
48
45
|
}
|
|
49
46
|
/**
|
|
50
|
-
*
|
|
47
|
+
* cache directory shared by users, same as `userCacheDir`
|
|
51
48
|
*/
|
|
52
49
|
get siteCacheDir() {
|
|
53
50
|
return this.userCacheDir;
|
|
54
51
|
}
|
|
55
52
|
/**
|
|
56
|
-
*
|
|
53
|
+
* state directory tied to the user, same as `userDataDir`
|
|
57
54
|
*/
|
|
58
55
|
get userStateDir() {
|
|
59
56
|
return this.userDataDir;
|
|
60
57
|
}
|
|
61
58
|
/**
|
|
62
|
-
*
|
|
59
|
+
* log directory tied to the user, same as `userCacheDir` if not opinionated else `log` in it, e.g. `/data/user/<userid>/<packagename>/cache/<AppName>/log`
|
|
63
60
|
*/
|
|
64
61
|
get userLogDir() {
|
|
65
62
|
let path2 = this.userCacheDir;
|
|
@@ -69,43 +66,43 @@ export class Android extends PlatformDirsABC {
|
|
|
69
66
|
return path2;
|
|
70
67
|
}
|
|
71
68
|
/**
|
|
72
|
-
*
|
|
69
|
+
* documents directory tied to the user, e.g. `/storage/emulated/0/Documents`
|
|
73
70
|
*/
|
|
74
71
|
get userDocumentsDir() {
|
|
75
72
|
return androidDocumentsFolder();
|
|
76
73
|
}
|
|
77
74
|
/**
|
|
78
|
-
*
|
|
75
|
+
* downloads directory tied to the user, e.g. `/storage/emulated/0/Downloads`
|
|
79
76
|
*/
|
|
80
77
|
get userDownloadsDir() {
|
|
81
78
|
return androidDownloadsFolder();
|
|
82
79
|
}
|
|
83
80
|
/**
|
|
84
|
-
*
|
|
81
|
+
* pictures directory tied to the user, e.g. `/storage/emulated/0/Pictures`
|
|
85
82
|
*/
|
|
86
83
|
get userPicturesDir() {
|
|
87
84
|
return androidPicturesFolder();
|
|
88
85
|
}
|
|
89
86
|
/**
|
|
90
|
-
*
|
|
87
|
+
* videos directory tied to the user, e.g. `/storage/emulated/0/Movies`
|
|
91
88
|
*/
|
|
92
89
|
get userVideosDir() {
|
|
93
90
|
return androidVideosFolder();
|
|
94
91
|
}
|
|
95
92
|
/**
|
|
96
|
-
*
|
|
93
|
+
* music directory tied to the user, e.g. `/storage/emulated/0/Music`
|
|
97
94
|
*/
|
|
98
95
|
get userMusicDir() {
|
|
99
96
|
return androidMusicFolder();
|
|
100
97
|
}
|
|
101
98
|
/**
|
|
102
|
-
*
|
|
99
|
+
* desktop directory tied to the user, e.g. `/storage/emulated/0/Desktop`
|
|
103
100
|
*/
|
|
104
101
|
get userDesktopDir() {
|
|
105
102
|
return "/storage/emulated/0/Desktop";
|
|
106
103
|
}
|
|
107
104
|
/**
|
|
108
|
-
*
|
|
105
|
+
* runtime directory tied to the user, same as `userCacheDir` if not opinionated else `tmp` in it, e.g. `/data/user/<userid>/<packagename>/cache/<AppName>/tmp`
|
|
109
106
|
*/
|
|
110
107
|
get userRuntimeDir() {
|
|
111
108
|
let path2 = this.userCacheDir;
|
|
@@ -115,13 +112,15 @@ export class Android extends PlatformDirsABC {
|
|
|
115
112
|
return path2;
|
|
116
113
|
}
|
|
117
114
|
/**
|
|
118
|
-
*
|
|
115
|
+
* runtime directory shared by users, same as `userRuntimeDir`
|
|
119
116
|
*/
|
|
120
117
|
get siteRuntimeDir() {
|
|
121
118
|
return this.userRuntimeDir;
|
|
122
119
|
}
|
|
123
120
|
}
|
|
124
|
-
/**
|
|
121
|
+
/**
|
|
122
|
+
* @ignore @internal
|
|
123
|
+
*/
|
|
125
124
|
export function _androidFolder() {
|
|
126
125
|
throw new Error("Not implemented");
|
|
127
126
|
}
|
package/dist/api.d.ts
CHANGED
|
@@ -2,9 +2,6 @@
|
|
|
2
2
|
* Base API.
|
|
3
3
|
* @module
|
|
4
4
|
*/
|
|
5
|
-
/**
|
|
6
|
-
* Abstract base class for platform directories.
|
|
7
|
-
*/
|
|
8
5
|
export declare abstract class PlatformDirsABC {
|
|
9
6
|
/**
|
|
10
7
|
* The name of the application.
|
|
@@ -54,147 +51,146 @@ export declare abstract class PlatformDirsABC {
|
|
|
54
51
|
ensureExists: boolean;
|
|
55
52
|
/**
|
|
56
53
|
* Create a new platform directory.
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
* @
|
|
61
|
-
|
|
62
|
-
* @param opinion See `opinion`
|
|
63
|
-
* @param ensureExists See `ensureExists`
|
|
64
|
-
*/
|
|
65
|
-
constructor(appname?: string, appauthor?: string | false, version?: string, roaming?: boolean, multipath?: boolean, opinion?: boolean, ensureExists?: boolean);
|
|
66
|
-
/** @ignore @internal */
|
|
54
|
+
*/
|
|
55
|
+
constructor(appname?: string | undefined, appauthor?: string | false | undefined, version?: string | undefined, roaming?: boolean, multipath?: boolean, opinion?: boolean, ensureExists?: boolean);
|
|
56
|
+
/**
|
|
57
|
+
* @ignore @internal
|
|
58
|
+
*/
|
|
67
59
|
protected _appendAppNameAndVersion(...base: string[]): string;
|
|
68
|
-
/**
|
|
60
|
+
/**
|
|
61
|
+
* @ignore @internal
|
|
62
|
+
*/
|
|
69
63
|
protected _optionallyCreateDirectory(dir: string): void;
|
|
70
|
-
/**
|
|
64
|
+
/**
|
|
65
|
+
* @ignore @internal
|
|
66
|
+
*/
|
|
71
67
|
protected _firstItemAsPathIfMultipath(directory: string): string;
|
|
72
68
|
/**
|
|
73
|
-
*
|
|
69
|
+
* data directory tied to the user
|
|
74
70
|
*/
|
|
75
71
|
abstract get userDataDir(): string;
|
|
76
72
|
/**
|
|
77
|
-
*
|
|
73
|
+
* data directory shared by users
|
|
78
74
|
*/
|
|
79
75
|
abstract get siteDataDir(): string;
|
|
80
76
|
/**
|
|
81
|
-
*
|
|
77
|
+
* config directory tied to the user
|
|
82
78
|
*/
|
|
83
79
|
abstract get userConfigDir(): string;
|
|
84
80
|
/**
|
|
85
|
-
*
|
|
81
|
+
* config directory shared by users
|
|
86
82
|
*/
|
|
87
83
|
abstract get siteConfigDir(): string;
|
|
88
84
|
/**
|
|
89
|
-
*
|
|
85
|
+
* cache directory tied to the user
|
|
90
86
|
*/
|
|
91
87
|
abstract get userCacheDir(): string;
|
|
92
88
|
/**
|
|
93
|
-
*
|
|
89
|
+
* cache directory shared by users
|
|
94
90
|
*/
|
|
95
91
|
abstract get siteCacheDir(): string;
|
|
96
92
|
/**
|
|
97
|
-
*
|
|
93
|
+
* state directory tied to the user
|
|
98
94
|
*/
|
|
99
95
|
abstract get userStateDir(): string;
|
|
100
96
|
/**
|
|
101
|
-
*
|
|
97
|
+
* log directory tied to the user
|
|
102
98
|
*/
|
|
103
99
|
abstract get userLogDir(): string;
|
|
104
100
|
/**
|
|
105
|
-
*
|
|
101
|
+
* documents directory tied to the user
|
|
106
102
|
*/
|
|
107
103
|
abstract get userDocumentsDir(): string;
|
|
108
104
|
/**
|
|
109
|
-
*
|
|
105
|
+
* downloads directory tied to the user
|
|
110
106
|
*/
|
|
111
107
|
abstract get userDownloadsDir(): string;
|
|
112
108
|
/**
|
|
113
|
-
*
|
|
109
|
+
* pictures directory tied to the user
|
|
114
110
|
*/
|
|
115
111
|
abstract get userPicturesDir(): string;
|
|
116
112
|
/**
|
|
117
|
-
*
|
|
113
|
+
* videos directory tied to the user
|
|
118
114
|
*/
|
|
119
115
|
abstract get userVideosDir(): string;
|
|
120
116
|
/**
|
|
121
|
-
*
|
|
117
|
+
* music directory tied to the user
|
|
122
118
|
*/
|
|
123
119
|
abstract get userMusicDir(): string;
|
|
124
120
|
/**
|
|
125
|
-
*
|
|
121
|
+
* desktop directory tied to the user
|
|
126
122
|
*/
|
|
127
123
|
abstract get userDesktopDir(): string;
|
|
128
124
|
/**
|
|
129
|
-
*
|
|
125
|
+
* runtime directory tied to the user
|
|
130
126
|
*/
|
|
131
127
|
abstract get userRuntimeDir(): string;
|
|
132
128
|
/**
|
|
133
|
-
*
|
|
129
|
+
* runtime directory shared by users
|
|
134
130
|
*/
|
|
135
131
|
abstract get siteRuntimeDir(): string;
|
|
136
132
|
/**
|
|
137
|
-
*
|
|
133
|
+
* data path tied to the user
|
|
138
134
|
*/
|
|
139
135
|
get userDataPath(): string;
|
|
140
136
|
/**
|
|
141
|
-
*
|
|
137
|
+
* data path shared by users
|
|
142
138
|
*/
|
|
143
139
|
get siteDataPath(): string;
|
|
144
140
|
/**
|
|
145
|
-
*
|
|
141
|
+
* config path tied to the user
|
|
146
142
|
*/
|
|
147
143
|
get userConfigPath(): string;
|
|
148
144
|
/**
|
|
149
|
-
*
|
|
145
|
+
* config path shared by users
|
|
150
146
|
*/
|
|
151
147
|
get siteConfigPath(): string;
|
|
152
148
|
/**
|
|
153
|
-
*
|
|
149
|
+
* cache path tied to the user
|
|
154
150
|
*/
|
|
155
151
|
get userCachePath(): string;
|
|
156
152
|
/**
|
|
157
|
-
*
|
|
153
|
+
* cache path shared by users
|
|
158
154
|
*/
|
|
159
155
|
get siteCachePath(): string;
|
|
160
156
|
/**
|
|
161
|
-
*
|
|
157
|
+
* state path tied to the user
|
|
162
158
|
*/
|
|
163
159
|
get userStatePath(): string;
|
|
164
160
|
/**
|
|
165
|
-
*
|
|
161
|
+
* log path tied to the user
|
|
166
162
|
*/
|
|
167
163
|
get userLogPath(): string;
|
|
168
164
|
/**
|
|
169
|
-
*
|
|
165
|
+
* documents path tied to the user
|
|
170
166
|
*/
|
|
171
167
|
get userDocumentsPath(): string;
|
|
172
168
|
/**
|
|
173
|
-
*
|
|
169
|
+
* downloads path tied to the user
|
|
174
170
|
*/
|
|
175
171
|
get userDownloadsPath(): string;
|
|
176
172
|
/**
|
|
177
|
-
*
|
|
173
|
+
* pictures path tied to the user
|
|
178
174
|
*/
|
|
179
175
|
get userPicturesPath(): string;
|
|
180
176
|
/**
|
|
181
|
-
*
|
|
177
|
+
* videos path tied to the user
|
|
182
178
|
*/
|
|
183
179
|
get userVideosPath(): string;
|
|
184
180
|
/**
|
|
185
|
-
*
|
|
181
|
+
* music path tied to the user
|
|
186
182
|
*/
|
|
187
183
|
get userMusicPath(): string;
|
|
188
184
|
/**
|
|
189
|
-
*
|
|
185
|
+
* desktop path tied to the user
|
|
190
186
|
*/
|
|
191
187
|
get userDesktopPath(): string;
|
|
192
188
|
/**
|
|
193
|
-
*
|
|
189
|
+
* runtime path tied to the user
|
|
194
190
|
*/
|
|
195
191
|
get userRuntimePath(): string;
|
|
196
192
|
/**
|
|
197
|
-
*
|
|
193
|
+
* runtime path shared by users
|
|
198
194
|
*/
|
|
199
195
|
get siteRuntimePath(): string;
|
|
200
196
|
/**
|