Skip to content

Function: generateZipFile()

ts
function generateZipFile(files: MwFile[], fileName?: string): Promise<MwFile>;

Defined in: packages/file-tools/lib/mwFile.d.ts:34

Experimental

Generate a ZIP file from an array of MwFiles.

Parameters

ParameterTypeDescription
filesMwFile[]The MwFiles to include in the archive.
fileName?stringName for the ZIP file. Defaults to 'archive.zip'.

Returns

Promise<MwFile>

A promise that resolves to an MwFile containing the ZIP archive.

Example

ts
const receipt = convertBase64ToMwFile(receiptData, 'receipt.pdf', 'application/pdf');
const photo = convertBase64ToMwFile(photoData, 'photo.jpg', 'image/jpeg');
const zip = await generateZipFile([receipt, photo], 'expense-report.zip');
console.log(zip.name); // 'expense-report.zip'

Matterway Assistant SDK Documentation