<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [mr-excel](./mr-excel.md) &gt; [generateCSV](./mr-excel.generatecsv.md)

## generateCSV() function

Generates a CSV file from an Excel table Object.

**Signature:**

```typescript
export declare function generateCSV<T extends object = object>(excelTable: ExcelTable<T>, asZip?: boolean): Promise<string[] | "done">;
```

## Parameters

<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

excelTable


</td><td>

ExcelTable&lt;T&gt;


</td><td>

The Excel table. See .


</td></tr>
<tr><td>

asZip


</td><td>

boolean


</td><td>

_(Optional)_ Whether to generate the CSV as a ZIP file.


</td></tr>
</tbody></table>

**Returns:**

Promise&lt;string\[\] \| "done"&gt;

{<!-- -->Promise<!-- -->&lt;<!-- -->string\[\] \| "done" \| undefined<!-- -->&gt;<!-- -->} The generated CSV file.

