Interface UploaderInterface

Defines the interface for an uploader. It allows us to upload files and get their URIs.

Hierarchy

UploaderInterface

Index

Properties

getUploadPrice upload uploadJson

Properties

getUploadPrice

getUploadPrice: ((files: GenericFile[], options?: UploaderGetUploadPriceOptions) => Promise<Amount<string, number>>)

Type declaration

- (files: GenericFile[], options?: UploaderGetUploadPriceOptions): Promise<Amount<string, number>>
- Gets the price to upload a list of files.
  Parameters
  - files: GenericFile[]
  - Optional options: UploaderGetUploadPriceOptions
  Returns Promise<Amount<string, number>>

upload

upload: ((files: GenericFile[], options?: UploaderUploadOptions) => Promise<string[]>)

Type declaration

- (files: GenericFile[], options?: UploaderUploadOptions): Promise<string[]>
- Uploads multiple files and returns their URIs.
  Parameters
  - files: GenericFile[]
  - Optional options: UploaderUploadOptions
  Returns Promise<string[]>

uploadJson

uploadJson: (<T>(json: T, options?: UploaderUploadOptions) => Promise<string>)

Type declaration

- <T>(json: T, options?: UploaderUploadOptions): Promise<string>
- Uploads a JSON object and returns its URI.
  Type Parameters
  - T
  Parameters
  - json: T
  - Optional options: UploaderUploadOptions
  Returns Promise<string>

Generated using TypeDoc