IChannelStorageService Interface
Storage services to read the objects at a given path.
Signature
export interface IChannelStorageService
Methods
| Method | Return Type | Description |
|---|---|---|
| contains(path) | Promise<boolean> | Determines if there is an object contained at the given path. |
| list(path) | Promise<string[]> | Lists the blobs that exist at a specific path. |
| readBlob(path) | Promise<ArrayBufferLike> | Reads the object contained at the given path. Returns a buffer representation for the object. |
Method Details
contains
Determines if there is an object contained at the given path.
Signature
contains(path: string): Promise<boolean>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| path | string |
Returns
Return type: Promise<boolean>
list
Lists the blobs that exist at a specific path.
Signature
list(path: string): Promise<string[]>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| path | string |
Returns
Return type: Promise<string[]>
readBlob
Reads the object contained at the given path. Returns a buffer representation for the object.
Signature
readBlob(path: string): Promise<ArrayBufferLike>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| path | string |
Returns
Return type: Promise<ArrayBufferLike>