A Flatfile plugin for exporting Workbooks to delimited files and zipping them together
npm i @flatfile/plugin-export-delimited-zipThe @flatfile/plugin-export-delimited-zip plugin exports data from Flatfile sheets to delimited files (e.g., CSV) and compresses them into a ZIP file. This plugin provides an efficient way to download and package your data from Flatfile workbooks.
Event Type:
job:ready
When embedding Flatfile, this plugin should be deployed in a server-side listener. Learn more
job - stringThe job name to trigger the export. Default: 'downloadDelimited'
delimiter - stringThe delimiter to use in the exported files. Default: ','
fileExtension - stringThe file extension for the exported files. Default: 'csv'
debug - boolean - (optional)Enable debug logging. Default: false
api.jobs.ackapi.jobs.completeapi.jobs.failapi.sheets.listapi.records.getapi.files.uploadinstall
npm install @flatfile/plugin-export-delimited-zip
listener.ts
import type { FlatfileListener } from '@flatfile/listener'
import { exportDelimitedZip } from '@flatfile/plugin-export-delimited-zip'
export default function (listener: FlatfileListener) {
listener.use(exportDelimitedZip({
job: 'export-delimited-zip',
delimiter: ',',
fileExtension: 'csv',
}))
}