Interface StorageClient

File support for the client. This interface establishes the contract for uploading files to the server and transforming the input to replace file objects with URLs.

interface StorageClient {
    transformInput: ((input: Record<string, any>) => Promise<Record<string, any>>);
    upload: ((file: Blob, options?: UploadOptions) => Promise<string>);
}

Properties

transformInput upload

Properties

transformInput

transformInput: ((input: Record<string, any>) => Promise<Record<string, any>>)

Transform the input to replace file objects with URLs. This is used to transform the input before sending it to the server and ensures that the server receives URLs instead of file objects.

Type declaration

upload

upload: ((file: Blob, options?: UploadOptions) => Promise<string>)

Upload a file to the server. Returns the URL of the uploaded file.

Files over MULTIPART_THRESHOLD are split into parts and uploaded sequentially.

Type declaration

    • (file, options?): Promise<string>

    • Parameters

      • file: Blob

        the file to upload

      • Optionaloptions: UploadOptions

        optional parameters, such as lifecycle configuration, a progress listener and multipart tuning

      Returns Promise<string>

      the URL of the uploaded file

Settings

Member Visibility

On This Page

Properties