Skip to main content

Type Alias: DownloadFile()

DownloadFile = (s3Path, fileName) => Promise<void>

Function

Initiates download of a specific file from storage.

This method prepares and starts the download process for a file stored in the system. It handles all the necessary authentication, URL generation, and browser download mechanisms, working reliably across different browsers and device types.

The method is typically called when a user clicks on a download button after browsing available files in product tabs. It triggers appropriate events for tracking downloads and handles the actual file transfer process.

Parameters​

s3Path​

string

Storage path to the file to be downloaded

fileName​

string

Name to use for the file when saving to the user's device

Returns​

Promise<void>

Example​

// Create a download button for a product manual
document.getElementById('download-manual').addEventListener('click', () => {
  window.mimeeqApp.actions.downloadFile(
    'manuals/product_123/installation_guide.pdf',
    'Installation_Guide.pdf'
  );
});

Emits​

mimeeq-download-file When the file download is initiated