Class StorageModule`Abstract`

Represents the abstract StorageModule for handling file uploads and downloads in Honeycomb.

Hierarchy

Module
- StorageModule
  - BundlrClient
  - BundlrClient

Index

Constructors

Properties

Methods

bundlr download downloadJson getUploadPriceForBytes getUploadPriceForFile getUploadPriceForFiles honeycomb install upload uploadAll uploadJson

Constructors

constructor

new StorageModule(): StorageModule
Returns StorageModule
Overrides Module.constructor
- Defined in packages/hive-control/modules/Storage/StorageModule.d.ts:14

Properties

`Protected` _honeycomb

_honeycomb: Honeycomb

Methods

bundlr

bundlr(): Promise<default | default>
Returns Promise<default | default>
- Defined in packages/hive-control/modules/Storage/BundlrClient.d.ts:24

download

download(uri): Promise<HoneycombFile>
Downloads a HoneycombFile from the provided URI.
Parameters
- uri: string
  
  The URI of the file to download.
Returns Promise<HoneycombFile>
The downloaded HoneycombFile.
- Defined in packages/hive-control/modules/Storage/StorageModule.d.ts:56

downloadJson

downloadJson<T>(uri): Promise<T>
Downloads a JSON object from the provided URI.
Type Parameters
- T extends object = object
Parameters
- uri: string
  
  The URI of the JSON object to download.
Returns Promise<T>
The downloaded JSON object.
- Defined in packages/hive-control/modules/Storage/StorageModule.d.ts:62

`Abstract` getUploadPriceForBytes

getUploadPriceForBytes(bytes): Promise<Amount>
Retrieves the upload price for a specified number of bytes.
Parameters
- bytes: number
  
  The number of bytes to calculate the upload price for.
Returns Promise<Amount>
The upload price in the form of an Amount.
- Defined in packages/hive-control/modules/Storage/StorageModule.d.ts:20

`Abstract` getUploadPriceForFile

getUploadPriceForFile(file): Promise<Amount>
Retrieves the upload price for a HoneycombFile.
Parameters
- file: HoneycombFile
  
  The HoneycombFile for which to calculate the upload price.
Returns Promise<Amount>
The upload price in the form of an Amount.
- Defined in packages/hive-control/modules/Storage/StorageModule.d.ts:26

`Abstract` getUploadPriceForFiles

getUploadPriceForFiles(files): Promise<Amount>
Retrieves the upload price for an array of HoneycombFiles.
Parameters
- files: HoneycombFile[]
  
  An array of HoneycombFiles to calculate the upload price for.
Returns Promise<Amount>
The upload price in the form of an Amount.
- Defined in packages/hive-control/modules/Storage/StorageModule.d.ts:32

honeycomb

honeycomb(): Honeycomb
Get the Honeycomb client instance associated with the module.

Returns Honeycomb
The Honeycomb client instance.
Inherited from Module.honeycomb
- Defined in packages/hive-control/Abstracts.d.ts:13

install

install(honeycomb): Honeycomb
Installs the StorageModule into the Honeycomb instance.
Parameters
- honeycomb: Honeycomb
  
  The Honeycomb instance to install the StorageModule into.
Returns Honeycomb
The Honeycomb instance with the StorageModule installed.
Overrides Module.install
- Defined in packages/hive-control/modules/Storage/StorageModule.d.ts:68

`Abstract` upload

upload(file): Promise<string>
Uploads a HoneycombFile to the Honeycomb storage.
Parameters
- file: HoneycombFile
  
  The HoneycombFile to upload.
Returns Promise<string>
The URI of the uploaded file.
- Defined in packages/hive-control/modules/Storage/StorageModule.d.ts:38

`Abstract` uploadAll

uploadAll(files): Promise<string[]>
Uploads an array of HoneycombFiles to the Honeycomb storage.
Parameters
- files: HoneycombFile[]
  
  An array of HoneycombFiles to upload.
Returns Promise<string[]>
An array of URIs for the uploaded files.
- Defined in packages/hive-control/modules/Storage/StorageModule.d.ts:44

uploadJson

uploadJson<T>(json): Promise<string>
Uploads a JSON object to the Honeycomb storage.
Type Parameters
- T extends object = object
Parameters
- json: T
  
  The JSON object to upload.
Returns Promise<string>
The URI of the uploaded file.
- Defined in packages/hive-control/modules/Storage/StorageModule.d.ts:50

Generated using TypeDoc