@fgv/ts-http-storage 5.1.0-4 → 5.1.0-40
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/dist/tsdoc-metadata.json +1 -1
- package/eslint.config.js +16 -0
- package/package.json +5 -5
- package/.rush/temp/6ab9195b15cc32c9f5e7e6f55bce0a88fab1fac6.tar.log +0 -61
- package/.rush/temp/chunked-rush-logs/ts-http-storage.build.chunks.jsonl +0 -9
- package/.rush/temp/operation/build/all.log +0 -9
- package/.rush/temp/operation/build/log-chunks.jsonl +0 -9
- package/.rush/temp/operation/build/state.json +0 -3
- package/.rush/temp/shrinkwrap-deps.json +0 -656
- package/config/api-extractor.json +0 -36
- package/config/rig.json +0 -10
- package/config/typedoc.json +0 -7
- package/docs/README.md +0 -298
- package/docs/classes/FsStorageProvider.createDirectory.md +0 -20
- package/docs/classes/FsStorageProvider.deleteFile.md +0 -20
- package/docs/classes/FsStorageProvider.getChildren.md +0 -20
- package/docs/classes/FsStorageProvider.getFile.md +0 -20
- package/docs/classes/FsStorageProvider.getItem.md +0 -20
- package/docs/classes/FsStorageProvider.md +0 -147
- package/docs/classes/FsStorageProvider.saveFile.md +0 -22
- package/docs/classes/FsStorageProvider.sync.md +0 -13
- package/docs/classes/FsStorageProviderFactory.forNamespace.md +0 -20
- package/docs/classes/FsStorageProviderFactory.md +0 -69
- package/docs/classes/HttpStorageService.createDirectory.md +0 -20
- package/docs/classes/HttpStorageService.deleteFile.md +0 -20
- package/docs/classes/HttpStorageService.getChildren.md +0 -20
- package/docs/classes/HttpStorageService.getFile.md +0 -20
- package/docs/classes/HttpStorageService.getItem.md +0 -20
- package/docs/classes/HttpStorageService.md +0 -145
- package/docs/classes/HttpStorageService.saveFile.md +0 -20
- package/docs/classes/HttpStorageService.sync.md +0 -20
- package/docs/functions/createStorageRoutes.md +0 -11
- package/docs/functions/normalizeRequestPath.md +0 -11
- package/docs/functions/sanitizeNamespace.md +0 -11
- package/docs/interfaces/ICreateStorageRoutesOptions.logger.md +0 -9
- package/docs/interfaces/ICreateStorageRoutesOptions.md +0 -61
- package/docs/interfaces/ICreateStorageRoutesOptions.providers.md +0 -9
- package/docs/interfaces/IFsStorageProviderFactoryOptions.md +0 -44
- package/docs/interfaces/IFsStorageProviderFactoryOptions.rootPath.md +0 -9
- package/docs/interfaces/IHttpStorageProvider.createDirectory.md +0 -20
- package/docs/interfaces/IHttpStorageProvider.deleteFile.md +0 -20
- package/docs/interfaces/IHttpStorageProvider.getChildren.md +0 -20
- package/docs/interfaces/IHttpStorageProvider.getFile.md +0 -20
- package/docs/interfaces/IHttpStorageProvider.getItem.md +0 -20
- package/docs/interfaces/IHttpStorageProvider.md +0 -115
- package/docs/interfaces/IHttpStorageProvider.saveFile.md +0 -22
- package/docs/interfaces/IHttpStorageProvider.sync.md +0 -13
- package/docs/interfaces/IHttpStorageProviderFactory.forNamespace.md +0 -20
- package/docs/interfaces/IHttpStorageProviderFactory.md +0 -36
- package/docs/interfaces/IStorageFileResponse.contentType.md +0 -9
- package/docs/interfaces/IStorageFileResponse.contents.md +0 -9
- package/docs/interfaces/IStorageFileResponse.md +0 -78
- package/docs/interfaces/IStorageFileResponse.path.md +0 -9
- package/docs/interfaces/IStoragePathRequest.md +0 -61
- package/docs/interfaces/IStoragePathRequest.namespace.md +0 -9
- package/docs/interfaces/IStoragePathRequest.path.md +0 -9
- package/docs/interfaces/IStorageSyncRequest.md +0 -44
- package/docs/interfaces/IStorageSyncRequest.namespace.md +0 -9
- package/docs/interfaces/IStorageSyncResponse.md +0 -44
- package/docs/interfaces/IStorageSyncResponse.synced.md +0 -9
- package/docs/interfaces/IStorageTreeChildrenResponse.children.md +0 -9
- package/docs/interfaces/IStorageTreeChildrenResponse.md +0 -61
- package/docs/interfaces/IStorageTreeChildrenResponse.path.md +0 -9
- package/docs/interfaces/IStorageTreeItem.md +0 -78
- package/docs/interfaces/IStorageTreeItem.name.md +0 -9
- package/docs/interfaces/IStorageTreeItem.path.md +0 -9
- package/docs/interfaces/IStorageTreeItem.type.md +0 -9
- package/docs/interfaces/IStorageWriteFileRequest.contentType.md +0 -9
- package/docs/interfaces/IStorageWriteFileRequest.contents.md +0 -9
- package/docs/interfaces/IStorageWriteFileRequest.md +0 -97
- package/docs/type-aliases/StorageItemType.md +0 -11
- package/docs/type-aliases/StorageNamespace.md +0 -11
- package/docs/variables/storageFileResponse.md +0 -9
- package/docs/variables/storagePathRequest.md +0 -9
- package/docs/variables/storageSyncRequest.md +0 -9
- package/docs/variables/storageTreeChildrenResponse.md +0 -9
- package/docs/variables/storageTreeItem.md +0 -9
- package/docs/variables/storageWriteFileRequest.md +0 -9
- package/etc/ts-http-storage.api.md +0 -184
- package/lib/test/unit/storage/fsProvider.test.d.ts +0 -2
- package/lib/test/unit/storage/fsProvider.test.d.ts.map +0 -1
- package/lib/test/unit/storage/fsProvider.test.js +0 -106
- package/lib/test/unit/storage/fsProvider.test.js.map +0 -1
- package/lib/test/unit/storage/routes.test.d.ts +0 -2
- package/lib/test/unit/storage/routes.test.d.ts.map +0 -1
- package/lib/test/unit/storage/routes.test.js +0 -124
- package/lib/test/unit/storage/routes.test.js.map +0 -1
- package/lib/test/unit/storage/service.test.d.ts +0 -2
- package/lib/test/unit/storage/service.test.d.ts.map +0 -1
- package/lib/test/unit/storage/service.test.js +0 -67
- package/lib/test/unit/storage/service.test.js.map +0 -1
- package/rush-logs/ts-http-storage.build.cache.log +0 -3
- package/rush-logs/ts-http-storage.build.log +0 -9
- package/src/index.ts +0 -28
- package/src/packlets/storage/converters.ts +0 -100
- package/src/packlets/storage/fsProvider.ts +0 -263
- package/src/packlets/storage/index.ts +0 -33
- package/src/packlets/storage/model.ts +0 -113
- package/src/packlets/storage/provider.ts +0 -33
- package/src/packlets/storage/routes.ts +0 -215
- package/src/packlets/storage/service.ts +0 -114
- package/src/test/unit/storage/fsProvider.test.ts +0 -129
- package/src/test/unit/storage/routes.test.ts +0 -165
- package/src/test/unit/storage/service.test.ts +0 -95
- package/temp/build/typescript/ts_l9Fw4VUO.json +0 -1
- package/temp/ts-http-storage.api.json +0 -3103
- package/temp/ts-http-storage.api.md +0 -184
- package/tsconfig.json +0 -7
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
[Home](../README.md) > FsStorageProviderFactory
|
|
2
|
-
|
|
3
|
-
# Class: FsStorageProviderFactory
|
|
4
|
-
|
|
5
|
-
Namespace-aware provider factory backed by filesystem directories.
|
|
6
|
-
|
|
7
|
-
**Implements:** [`IHttpStorageProviderFactory`](../interfaces/IHttpStorageProviderFactory.md)
|
|
8
|
-
|
|
9
|
-
## Constructors
|
|
10
|
-
|
|
11
|
-
<table><thead><tr><th>
|
|
12
|
-
|
|
13
|
-
Constructor
|
|
14
|
-
|
|
15
|
-
</th><th>
|
|
16
|
-
|
|
17
|
-
Modifiers
|
|
18
|
-
|
|
19
|
-
</th><th>
|
|
20
|
-
|
|
21
|
-
Description
|
|
22
|
-
|
|
23
|
-
</th></tr></thead>
|
|
24
|
-
<tbody>
|
|
25
|
-
<tr><td>
|
|
26
|
-
|
|
27
|
-
`constructor(options)`
|
|
28
|
-
|
|
29
|
-
</td><td>
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
</td><td>
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
</td></tr>
|
|
38
|
-
</tbody></table>
|
|
39
|
-
|
|
40
|
-
## Methods
|
|
41
|
-
|
|
42
|
-
<table><thead><tr><th>
|
|
43
|
-
|
|
44
|
-
Method
|
|
45
|
-
|
|
46
|
-
</th><th>
|
|
47
|
-
|
|
48
|
-
Modifiers
|
|
49
|
-
|
|
50
|
-
</th><th>
|
|
51
|
-
|
|
52
|
-
Description
|
|
53
|
-
|
|
54
|
-
</th></tr></thead>
|
|
55
|
-
<tbody>
|
|
56
|
-
<tr><td>
|
|
57
|
-
|
|
58
|
-
[forNamespace(namespace)](./FsStorageProviderFactory.forNamespace.md)
|
|
59
|
-
|
|
60
|
-
</td><td>
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
</td><td>
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
</td></tr>
|
|
69
|
-
</tbody></table>
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
[Home](../README.md) > [HttpStorageService](./HttpStorageService.md) > createDirectory
|
|
2
|
-
|
|
3
|
-
## HttpStorageService.createDirectory() method
|
|
4
|
-
|
|
5
|
-
**Signature:**
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
createDirectory(request: IStoragePathRequest): Promise<Result<IStorageTreeItem>>;
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
**Parameters:**
|
|
12
|
-
|
|
13
|
-
<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
|
|
14
|
-
<tbody>
|
|
15
|
-
<tr><td>request</td><td>IStoragePathRequest</td><td></td></tr>
|
|
16
|
-
</tbody></table>
|
|
17
|
-
|
|
18
|
-
**Returns:**
|
|
19
|
-
|
|
20
|
-
Promise<Result<[IStorageTreeItem](../interfaces/IStorageTreeItem.md)>>
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
[Home](../README.md) > [HttpStorageService](./HttpStorageService.md) > deleteFile
|
|
2
|
-
|
|
3
|
-
## HttpStorageService.deleteFile() method
|
|
4
|
-
|
|
5
|
-
**Signature:**
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
deleteFile(request: IStoragePathRequest): Promise<Result<boolean>>;
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
**Parameters:**
|
|
12
|
-
|
|
13
|
-
<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
|
|
14
|
-
<tbody>
|
|
15
|
-
<tr><td>request</td><td>IStoragePathRequest</td><td></td></tr>
|
|
16
|
-
</tbody></table>
|
|
17
|
-
|
|
18
|
-
**Returns:**
|
|
19
|
-
|
|
20
|
-
Promise<Result<boolean>>
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
[Home](../README.md) > [HttpStorageService](./HttpStorageService.md) > getChildren
|
|
2
|
-
|
|
3
|
-
## HttpStorageService.getChildren() method
|
|
4
|
-
|
|
5
|
-
**Signature:**
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
getChildren(request: IStoragePathRequest): Promise<Result<IStorageTreeChildrenResponse>>;
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
**Parameters:**
|
|
12
|
-
|
|
13
|
-
<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
|
|
14
|
-
<tbody>
|
|
15
|
-
<tr><td>request</td><td>IStoragePathRequest</td><td></td></tr>
|
|
16
|
-
</tbody></table>
|
|
17
|
-
|
|
18
|
-
**Returns:**
|
|
19
|
-
|
|
20
|
-
Promise<Result<[IStorageTreeChildrenResponse](../interfaces/IStorageTreeChildrenResponse.md)>>
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
[Home](../README.md) > [HttpStorageService](./HttpStorageService.md) > getFile
|
|
2
|
-
|
|
3
|
-
## HttpStorageService.getFile() method
|
|
4
|
-
|
|
5
|
-
**Signature:**
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
getFile(request: IStoragePathRequest): Promise<Result<IStorageFileResponse>>;
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
**Parameters:**
|
|
12
|
-
|
|
13
|
-
<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
|
|
14
|
-
<tbody>
|
|
15
|
-
<tr><td>request</td><td>IStoragePathRequest</td><td></td></tr>
|
|
16
|
-
</tbody></table>
|
|
17
|
-
|
|
18
|
-
**Returns:**
|
|
19
|
-
|
|
20
|
-
Promise<Result<[IStorageFileResponse](../interfaces/IStorageFileResponse.md)>>
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
[Home](../README.md) > [HttpStorageService](./HttpStorageService.md) > getItem
|
|
2
|
-
|
|
3
|
-
## HttpStorageService.getItem() method
|
|
4
|
-
|
|
5
|
-
**Signature:**
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
getItem(request: IStoragePathRequest): Promise<Result<IStorageTreeItem>>;
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
**Parameters:**
|
|
12
|
-
|
|
13
|
-
<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
|
|
14
|
-
<tbody>
|
|
15
|
-
<tr><td>request</td><td>IStoragePathRequest</td><td></td></tr>
|
|
16
|
-
</tbody></table>
|
|
17
|
-
|
|
18
|
-
**Returns:**
|
|
19
|
-
|
|
20
|
-
Promise<Result<[IStorageTreeItem](../interfaces/IStorageTreeItem.md)>>
|
|
@@ -1,145 +0,0 @@
|
|
|
1
|
-
[Home](../README.md) > HttpStorageService
|
|
2
|
-
|
|
3
|
-
# Class: HttpStorageService
|
|
4
|
-
|
|
5
|
-
Service layer for storage API operations.
|
|
6
|
-
|
|
7
|
-
## Constructors
|
|
8
|
-
|
|
9
|
-
<table><thead><tr><th>
|
|
10
|
-
|
|
11
|
-
Constructor
|
|
12
|
-
|
|
13
|
-
</th><th>
|
|
14
|
-
|
|
15
|
-
Modifiers
|
|
16
|
-
|
|
17
|
-
</th><th>
|
|
18
|
-
|
|
19
|
-
Description
|
|
20
|
-
|
|
21
|
-
</th></tr></thead>
|
|
22
|
-
<tbody>
|
|
23
|
-
<tr><td>
|
|
24
|
-
|
|
25
|
-
`constructor(providers)`
|
|
26
|
-
|
|
27
|
-
</td><td>
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
</td><td>
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
</td></tr>
|
|
36
|
-
</tbody></table>
|
|
37
|
-
|
|
38
|
-
## Methods
|
|
39
|
-
|
|
40
|
-
<table><thead><tr><th>
|
|
41
|
-
|
|
42
|
-
Method
|
|
43
|
-
|
|
44
|
-
</th><th>
|
|
45
|
-
|
|
46
|
-
Modifiers
|
|
47
|
-
|
|
48
|
-
</th><th>
|
|
49
|
-
|
|
50
|
-
Description
|
|
51
|
-
|
|
52
|
-
</th></tr></thead>
|
|
53
|
-
<tbody>
|
|
54
|
-
<tr><td>
|
|
55
|
-
|
|
56
|
-
[getItem(request)](./HttpStorageService.getItem.md)
|
|
57
|
-
|
|
58
|
-
</td><td>
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
</td><td>
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
</td></tr>
|
|
67
|
-
<tr><td>
|
|
68
|
-
|
|
69
|
-
[getChildren(request)](./HttpStorageService.getChildren.md)
|
|
70
|
-
|
|
71
|
-
</td><td>
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
</td><td>
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
</td></tr>
|
|
80
|
-
<tr><td>
|
|
81
|
-
|
|
82
|
-
[getFile(request)](./HttpStorageService.getFile.md)
|
|
83
|
-
|
|
84
|
-
</td><td>
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
</td><td>
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
</td></tr>
|
|
93
|
-
<tr><td>
|
|
94
|
-
|
|
95
|
-
[saveFile(request)](./HttpStorageService.saveFile.md)
|
|
96
|
-
|
|
97
|
-
</td><td>
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
</td><td>
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
</td></tr>
|
|
106
|
-
<tr><td>
|
|
107
|
-
|
|
108
|
-
[deleteFile(request)](./HttpStorageService.deleteFile.md)
|
|
109
|
-
|
|
110
|
-
</td><td>
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
</td><td>
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
</td></tr>
|
|
119
|
-
<tr><td>
|
|
120
|
-
|
|
121
|
-
[createDirectory(request)](./HttpStorageService.createDirectory.md)
|
|
122
|
-
|
|
123
|
-
</td><td>
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
</td><td>
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
</td></tr>
|
|
132
|
-
<tr><td>
|
|
133
|
-
|
|
134
|
-
[sync(request)](./HttpStorageService.sync.md)
|
|
135
|
-
|
|
136
|
-
</td><td>
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
</td><td>
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
</td></tr>
|
|
145
|
-
</tbody></table>
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
[Home](../README.md) > [HttpStorageService](./HttpStorageService.md) > saveFile
|
|
2
|
-
|
|
3
|
-
## HttpStorageService.saveFile() method
|
|
4
|
-
|
|
5
|
-
**Signature:**
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
saveFile(request: IStorageWriteFileRequest): Promise<Result<IStorageFileResponse>>;
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
**Parameters:**
|
|
12
|
-
|
|
13
|
-
<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
|
|
14
|
-
<tbody>
|
|
15
|
-
<tr><td>request</td><td>IStorageWriteFileRequest</td><td></td></tr>
|
|
16
|
-
</tbody></table>
|
|
17
|
-
|
|
18
|
-
**Returns:**
|
|
19
|
-
|
|
20
|
-
Promise<Result<[IStorageFileResponse](../interfaces/IStorageFileResponse.md)>>
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
[Home](../README.md) > [HttpStorageService](./HttpStorageService.md) > sync
|
|
2
|
-
|
|
3
|
-
## HttpStorageService.sync() method
|
|
4
|
-
|
|
5
|
-
**Signature:**
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
sync(request: IStorageSyncRequest): Promise<Result<IStorageSyncResponse>>;
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
**Parameters:**
|
|
12
|
-
|
|
13
|
-
<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
|
|
14
|
-
<tbody>
|
|
15
|
-
<tr><td>request</td><td>IStorageSyncRequest</td><td></td></tr>
|
|
16
|
-
</tbody></table>
|
|
17
|
-
|
|
18
|
-
**Returns:**
|
|
19
|
-
|
|
20
|
-
Promise<Result<[IStorageSyncResponse](../interfaces/IStorageSyncResponse.md)>>
|
|
@@ -1,61 +0,0 @@
|
|
|
1
|
-
[Home](../README.md) > ICreateStorageRoutesOptions
|
|
2
|
-
|
|
3
|
-
# Interface: ICreateStorageRoutesOptions
|
|
4
|
-
|
|
5
|
-
Options for creating storage routes.
|
|
6
|
-
|
|
7
|
-
## Properties
|
|
8
|
-
|
|
9
|
-
<table><thead><tr><th>
|
|
10
|
-
|
|
11
|
-
Property
|
|
12
|
-
|
|
13
|
-
</th><th>
|
|
14
|
-
|
|
15
|
-
Modifiers
|
|
16
|
-
|
|
17
|
-
</th><th>
|
|
18
|
-
|
|
19
|
-
Type
|
|
20
|
-
|
|
21
|
-
</th><th>
|
|
22
|
-
|
|
23
|
-
Description
|
|
24
|
-
|
|
25
|
-
</th></tr></thead>
|
|
26
|
-
<tbody>
|
|
27
|
-
<tr><td>
|
|
28
|
-
|
|
29
|
-
[providers](./ICreateStorageRoutesOptions.providers.md)
|
|
30
|
-
|
|
31
|
-
</td><td>
|
|
32
|
-
|
|
33
|
-
`readonly`
|
|
34
|
-
|
|
35
|
-
</td><td>
|
|
36
|
-
|
|
37
|
-
[IHttpStorageProviderFactory](IHttpStorageProviderFactory.md)
|
|
38
|
-
|
|
39
|
-
</td><td>
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
</td></tr>
|
|
44
|
-
<tr><td>
|
|
45
|
-
|
|
46
|
-
[logger](./ICreateStorageRoutesOptions.logger.md)
|
|
47
|
-
|
|
48
|
-
</td><td>
|
|
49
|
-
|
|
50
|
-
`readonly`
|
|
51
|
-
|
|
52
|
-
</td><td>
|
|
53
|
-
|
|
54
|
-
ILogger
|
|
55
|
-
|
|
56
|
-
</td><td>
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
</td></tr>
|
|
61
|
-
</tbody></table>
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
[Home](../README.md) > IFsStorageProviderFactoryOptions
|
|
2
|
-
|
|
3
|
-
# Interface: IFsStorageProviderFactoryOptions
|
|
4
|
-
|
|
5
|
-
Options for creating filesystem-backed storage providers.
|
|
6
|
-
|
|
7
|
-
## Properties
|
|
8
|
-
|
|
9
|
-
<table><thead><tr><th>
|
|
10
|
-
|
|
11
|
-
Property
|
|
12
|
-
|
|
13
|
-
</th><th>
|
|
14
|
-
|
|
15
|
-
Modifiers
|
|
16
|
-
|
|
17
|
-
</th><th>
|
|
18
|
-
|
|
19
|
-
Type
|
|
20
|
-
|
|
21
|
-
</th><th>
|
|
22
|
-
|
|
23
|
-
Description
|
|
24
|
-
|
|
25
|
-
</th></tr></thead>
|
|
26
|
-
<tbody>
|
|
27
|
-
<tr><td>
|
|
28
|
-
|
|
29
|
-
[rootPath](./IFsStorageProviderFactoryOptions.rootPath.md)
|
|
30
|
-
|
|
31
|
-
</td><td>
|
|
32
|
-
|
|
33
|
-
`readonly`
|
|
34
|
-
|
|
35
|
-
</td><td>
|
|
36
|
-
|
|
37
|
-
string
|
|
38
|
-
|
|
39
|
-
</td><td>
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
</td></tr>
|
|
44
|
-
</tbody></table>
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
[Home](../README.md) > [IHttpStorageProvider](./IHttpStorageProvider.md) > createDirectory
|
|
2
|
-
|
|
3
|
-
## IHttpStorageProvider.createDirectory() method
|
|
4
|
-
|
|
5
|
-
**Signature:**
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
createDirectory(path: string): Promise<Result<IStorageTreeItem>>;
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
**Parameters:**
|
|
12
|
-
|
|
13
|
-
<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
|
|
14
|
-
<tbody>
|
|
15
|
-
<tr><td>path</td><td>string</td><td></td></tr>
|
|
16
|
-
</tbody></table>
|
|
17
|
-
|
|
18
|
-
**Returns:**
|
|
19
|
-
|
|
20
|
-
Promise<Result<[IStorageTreeItem](IStorageTreeItem.md)>>
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
[Home](../README.md) > [IHttpStorageProvider](./IHttpStorageProvider.md) > deleteFile
|
|
2
|
-
|
|
3
|
-
## IHttpStorageProvider.deleteFile() method
|
|
4
|
-
|
|
5
|
-
**Signature:**
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
deleteFile(path: string): Promise<Result<boolean>>;
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
**Parameters:**
|
|
12
|
-
|
|
13
|
-
<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
|
|
14
|
-
<tbody>
|
|
15
|
-
<tr><td>path</td><td>string</td><td></td></tr>
|
|
16
|
-
</tbody></table>
|
|
17
|
-
|
|
18
|
-
**Returns:**
|
|
19
|
-
|
|
20
|
-
Promise<Result<boolean>>
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
[Home](../README.md) > [IHttpStorageProvider](./IHttpStorageProvider.md) > getChildren
|
|
2
|
-
|
|
3
|
-
## IHttpStorageProvider.getChildren() method
|
|
4
|
-
|
|
5
|
-
**Signature:**
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
getChildren(path: string): Promise<Result<readonly IStorageTreeItem[]>>;
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
**Parameters:**
|
|
12
|
-
|
|
13
|
-
<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
|
|
14
|
-
<tbody>
|
|
15
|
-
<tr><td>path</td><td>string</td><td></td></tr>
|
|
16
|
-
</tbody></table>
|
|
17
|
-
|
|
18
|
-
**Returns:**
|
|
19
|
-
|
|
20
|
-
Promise<Result<readonly [IStorageTreeItem](IStorageTreeItem.md)[]>>
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
[Home](../README.md) > [IHttpStorageProvider](./IHttpStorageProvider.md) > getFile
|
|
2
|
-
|
|
3
|
-
## IHttpStorageProvider.getFile() method
|
|
4
|
-
|
|
5
|
-
**Signature:**
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
getFile(path: string): Promise<Result<IStorageFileResponse>>;
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
**Parameters:**
|
|
12
|
-
|
|
13
|
-
<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
|
|
14
|
-
<tbody>
|
|
15
|
-
<tr><td>path</td><td>string</td><td></td></tr>
|
|
16
|
-
</tbody></table>
|
|
17
|
-
|
|
18
|
-
**Returns:**
|
|
19
|
-
|
|
20
|
-
Promise<Result<[IStorageFileResponse](IStorageFileResponse.md)>>
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
[Home](../README.md) > [IHttpStorageProvider](./IHttpStorageProvider.md) > getItem
|
|
2
|
-
|
|
3
|
-
## IHttpStorageProvider.getItem() method
|
|
4
|
-
|
|
5
|
-
**Signature:**
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
getItem(path: string): Promise<Result<IStorageTreeItem>>;
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
**Parameters:**
|
|
12
|
-
|
|
13
|
-
<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
|
|
14
|
-
<tbody>
|
|
15
|
-
<tr><td>path</td><td>string</td><td></td></tr>
|
|
16
|
-
</tbody></table>
|
|
17
|
-
|
|
18
|
-
**Returns:**
|
|
19
|
-
|
|
20
|
-
Promise<Result<[IStorageTreeItem](IStorageTreeItem.md)>>
|