@fgv/ts-http-storage 5.1.0-1

package/docs/interfaces/IHttpStorageProvider.createDirectory.md

@@ -0,0 +1,20 @@
+[Home](../README.md) > [IHttpStorageProvider](./IHttpStorageProvider.md) > createDirectory
+
+## IHttpStorageProvider.createDirectory() method
+
+**Signature:**
+
+```typescript
+createDirectory(path: string): Promise<Result<IStorageTreeItem>>;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>path</td><td>string</td><td></td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;Result&lt;[IStorageTreeItem](IStorageTreeItem.md)&gt;&gt;

package/docs/interfaces/IHttpStorageProvider.getChildren.md

@@ -0,0 +1,20 @@
+[Home](../README.md) > [IHttpStorageProvider](./IHttpStorageProvider.md) > getChildren
+
+## IHttpStorageProvider.getChildren() method
+
+**Signature:**
+
+```typescript
+getChildren(path: string): Promise<Result<readonly IStorageTreeItem[]>>;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>path</td><td>string</td><td></td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;Result&lt;readonly [IStorageTreeItem](IStorageTreeItem.md)[]&gt;&gt;

package/docs/interfaces/IHttpStorageProvider.getFile.md

@@ -0,0 +1,20 @@
+[Home](../README.md) > [IHttpStorageProvider](./IHttpStorageProvider.md) > getFile
+
+## IHttpStorageProvider.getFile() method
+
+**Signature:**
+
+```typescript
+getFile(path: string): Promise<Result<IStorageFileResponse>>;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>path</td><td>string</td><td></td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;Result&lt;[IStorageFileResponse](IStorageFileResponse.md)&gt;&gt;

package/docs/interfaces/IHttpStorageProvider.getItem.md

@@ -0,0 +1,20 @@
+[Home](../README.md) > [IHttpStorageProvider](./IHttpStorageProvider.md) > getItem
+
+## IHttpStorageProvider.getItem() method
+
+**Signature:**
+
+```typescript
+getItem(path: string): Promise<Result<IStorageTreeItem>>;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>path</td><td>string</td><td></td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;Result&lt;[IStorageTreeItem](IStorageTreeItem.md)&gt;&gt;

package/docs/interfaces/IHttpStorageProvider.md

@@ -0,0 +1,102 @@
+[Home](../README.md) > IHttpStorageProvider
+
+# Interface: IHttpStorageProvider
+
+Provider contract for storage backends.
+All methods are async to support both filesystem and database backends.
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[getItem(path)](./IHttpStorageProvider.getItem.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[getChildren(path)](./IHttpStorageProvider.getChildren.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[getFile(path)](./IHttpStorageProvider.getFile.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[saveFile(path, contents, contentType)](./IHttpStorageProvider.saveFile.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[createDirectory(path)](./IHttpStorageProvider.createDirectory.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[sync()](./IHttpStorageProvider.sync.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/IHttpStorageProvider.saveFile.md

@@ -0,0 +1,22 @@
+[Home](../README.md) > [IHttpStorageProvider](./IHttpStorageProvider.md) > saveFile
+
+## IHttpStorageProvider.saveFile() method
+
+**Signature:**
+
+```typescript
+saveFile(path: string, contents: string, contentType?: string): Promise<Result<IStorageFileResponse>>;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>path</td><td>string</td><td></td></tr>
+<tr><td>contents</td><td>string</td><td></td></tr>
+<tr><td>contentType</td><td>string</td><td></td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;Result&lt;[IStorageFileResponse](IStorageFileResponse.md)&gt;&gt;

package/docs/interfaces/IHttpStorageProvider.sync.md

@@ -0,0 +1,13 @@
+[Home](../README.md) > [IHttpStorageProvider](./IHttpStorageProvider.md) > sync
+
+## IHttpStorageProvider.sync() method
+
+**Signature:**
+
+```typescript
+sync(): Promise<Result<IStorageSyncResponse>>;
+```
+
+**Returns:**
+
+Promise&lt;Result&lt;[IStorageSyncResponse](IStorageSyncResponse.md)&gt;&gt;

package/docs/interfaces/IHttpStorageProviderFactory.forNamespace.md

@@ -0,0 +1,20 @@
+[Home](../README.md) > [IHttpStorageProviderFactory](./IHttpStorageProviderFactory.md) > forNamespace
+
+## IHttpStorageProviderFactory.forNamespace() method
+
+**Signature:**
+
+```typescript
+forNamespace(namespace?: string): Result<IHttpStorageProvider>;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>namespace</td><td>string</td><td></td></tr>
+</tbody></table>
+
+**Returns:**
+
+Result&lt;[IHttpStorageProvider](IHttpStorageProvider.md)&gt;

package/docs/interfaces/IHttpStorageProviderFactory.md

@@ -0,0 +1,36 @@
+[Home](../README.md) > IHttpStorageProviderFactory
+
+# Interface: IHttpStorageProviderFactory
+
+Factory for creating namespace-scoped storage providers.
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[forNamespace(namespace)](./IHttpStorageProviderFactory.forNamespace.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/IStorageFileResponse.contentType.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [IStorageFileResponse](./IStorageFileResponse.md) > contentType
+
+## IStorageFileResponse.contentType property
+
+**Signature:**
+
+```typescript
+readonly contentType: string;
+```

package/docs/interfaces/IStorageFileResponse.contents.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [IStorageFileResponse](./IStorageFileResponse.md) > contents
+
+## IStorageFileResponse.contents property
+
+**Signature:**
+
+```typescript
+readonly contents: string;
+```

package/docs/interfaces/IStorageFileResponse.md

@@ -0,0 +1,78 @@
+[Home](../README.md) > IStorageFileResponse
+
+# Interface: IStorageFileResponse
+
+Response for reading a file.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[path](./IStorageFileResponse.path.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[contents](./IStorageFileResponse.contents.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[contentType](./IStorageFileResponse.contentType.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/IStorageFileResponse.path.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [IStorageFileResponse](./IStorageFileResponse.md) > path
+
+## IStorageFileResponse.path property
+
+**Signature:**
+
+```typescript
+readonly path: string;
+```

package/docs/interfaces/IStoragePathRequest.md

@@ -0,0 +1,61 @@
+[Home](../README.md) > IStoragePathRequest
+
+# Interface: IStoragePathRequest
+
+Request for path-based operations.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[path](./IStoragePathRequest.path.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[namespace](./IStoragePathRequest.namespace.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/IStoragePathRequest.namespace.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [IStoragePathRequest](./IStoragePathRequest.md) > namespace
+
+## IStoragePathRequest.namespace property
+
+**Signature:**
+
+```typescript
+readonly namespace: string;
+```

package/docs/interfaces/IStoragePathRequest.path.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [IStoragePathRequest](./IStoragePathRequest.md) > path
+
+## IStoragePathRequest.path property
+
+**Signature:**
+
+```typescript
+readonly path: string;
+```

package/docs/interfaces/IStorageSyncRequest.md

@@ -0,0 +1,44 @@
+[Home](../README.md) > IStorageSyncRequest
+
+# Interface: IStorageSyncRequest
+
+Request for sync operation.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[namespace](./IStorageSyncRequest.namespace.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/IStorageSyncRequest.namespace.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [IStorageSyncRequest](./IStorageSyncRequest.md) > namespace
+
+## IStorageSyncRequest.namespace property
+
+**Signature:**
+
+```typescript
+readonly namespace: string;
+```

package/docs/interfaces/IStorageSyncResponse.md

@@ -0,0 +1,44 @@
+[Home](../README.md) > IStorageSyncResponse
+
+# Interface: IStorageSyncResponse
+
+Sync response metadata.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[synced](./IStorageSyncResponse.synced.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+number
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/IStorageSyncResponse.synced.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [IStorageSyncResponse](./IStorageSyncResponse.md) > synced
+
+## IStorageSyncResponse.synced property
+
+**Signature:**
+
+```typescript
+readonly synced: number;
+```

package/docs/interfaces/IStorageTreeChildrenResponse.children.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [IStorageTreeChildrenResponse](./IStorageTreeChildrenResponse.md) > children
+
+## IStorageTreeChildrenResponse.children property
+
+**Signature:**
+
+```typescript
+readonly children: readonly IStorageTreeItem[];
+```

package/docs/interfaces/IStorageTreeChildrenResponse.md

@@ -0,0 +1,61 @@
+[Home](../README.md) > IStorageTreeChildrenResponse
+
+# Interface: IStorageTreeChildrenResponse
+
+Response for listing children.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[path](./IStorageTreeChildrenResponse.path.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[children](./IStorageTreeChildrenResponse.children.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+readonly [IStorageTreeItem](IStorageTreeItem.md)[]
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/IStorageTreeChildrenResponse.path.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [IStorageTreeChildrenResponse](./IStorageTreeChildrenResponse.md) > path
+
+## IStorageTreeChildrenResponse.path property
+
+**Signature:**
+
+```typescript
+readonly path: string;
+```